120 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
a95190690b Merge pull request 'Use Poetry instead of Pip to manage requirements' (#28) from move-to-poetry into master
Reviewed-on: #28

Closes #25
2026-05-18 23:21:17 +02:00
n07070
b0e394f9d1 Update the import of the printer package 2026-05-18 23:19:21 +02:00
n07070
6254d60429 Add poetry lock file and project toml 2026-05-18 23:17:18 +02:00
n07070
f408c47c27 Remove run.sh 2026-05-18 23:17:08 +02:00
n07070
a1cfb7a3ba Remove pip requirement 2026-05-18 23:16:57 +02:00
n07070
d2f181cb22 Remove the pip selfcheck 2026-05-18 23:16:45 +02:00
n07070
cc16704651 Remove the debug argument from the systemd service 2026-05-18 23:16:28 +02:00
n07070
36ae95c26f Update README for poetry 2026-05-18 23:15:35 +02:00
n07070
dc7495cd15 Add Poetry files 2026-05-18 02:09:18 +02:00
n07070
f2d9006a12 Update webcam data management 2026-05-17 20:37:45 +02:00
n07070
52e0a09552 Add default signature 2026-05-17 20:37:23 +02:00
n07070
16c1ef4d72 Add countdown to the webcam, and fix flipping 2026-05-17 17:15:40 +02:00
n07070
002dc2eb8e Add countdown CSS 2026-05-17 16:39:42 +02:00
n07070
85c10a47b0 Update linting with black 2026-05-17 14:24:07 +02:00
n07070
641b8a2d1f Update index html to remove the required attribute for the signature 2026-05-17 14:22:57 +02:00
n07070
07dbe9be84 Close #3 : Add information about seting up udev permissions 2026-05-17 13:02:31 +02:00
n07070
6888a69ee7 Close #11 : Make the signature optionnal, lint file 2026-05-17 12:58:05 +02:00
n07070
0f9135707a Add a configuration option for default signature 2026-05-17 12:54:23 +02:00
n07070
9bdd1b4569 Added a comment about linting in the README 2026-05-17 12:54:09 +02:00
n07070
4fd2d55cbd Closes #24 : Add webp as allowed extension 2026-05-17 00:52:16 +02:00
d41114b5a2 Merge pull request 'Acces-libre : Raspberry Pi integration' (#8) from acces-libre into master
Reviewed-on: #8
2026-03-30 11:06:05 +02:00
n07070
44a5f6ddad Lint project 2026-03-30 11:05:13 +02:00
n07070
e437beac59 Add 3d models of the printer and raspberry pi 2026-03-30 11:05:13 +02:00
n07070
3afd679148 Ajout des logos de extase club 2026-03-30 11:05:13 +02:00
nono
cdba783f45 Update code to better handle the raspberry pi mode 2026-03-30 11:05:13 +02:00
nono
67b7de11e9 Add systemd service 2026-03-30 11:05:13 +02:00
nono
39d0c56672 Change signature 2026-03-30 11:05:13 +02:00
nono
11a5dc3587 Remove flash from the printer class, update web class 2026-03-30 11:05:13 +02:00
nono
5207fa5b4e update raspberry pi code 2026-03-30 11:05:13 +02:00
nono
20a22b379d Add configuration ports for the flash 2026-03-30 11:05:13 +02:00
nono
13968ac7bc Add requirements 2026-03-30 11:05:13 +02:00
nono
7131b68dbd Update readme with more deps 2026-03-30 11:05:13 +02:00
nono
000c7e9eec Update gitignore 2026-03-30 11:05:13 +02:00
nono
8157c5cb9d Rework the webcam detection 2026-03-30 11:05:13 +02:00
nono
1a1c4e2fb3 Update little printer requirements 2026-03-30 11:05:13 +02:00
nono
d4a9a059bf Add configuration section for the rapsberry pi 2026-03-30 11:05:13 +02:00
nono
aa6e11c537 Ajout de quelques changements pour acces libre 2026-03-30 11:05:13 +02:00
n07070
0601fe8190 Add information on contributions 2026-01-04 12:07:10 +01:00
nono
3dc6a41724 Update requiremetnss 2025-06-11 00:44:12 +02:00
nono
abaf506d56 Change the return type to a JSON message for the API, add logging 2025-06-10 19:57:33 +02:00
nono
866d89eb09 Add video attributs 2025-06-10 19:38:55 +02:00
nono
7df902df52 Remove one button, streamline UI 2025-06-10 19:38:42 +02:00
nono
80b16f260e Add contrast correction 2025-06-10 19:38:29 +02:00
nono
1735e468aa Add SSL context and folder creation for the uploads 2025-06-10 19:37:59 +02:00
nono
38b3acfb89 Update the webcame and printing image part 2025-05-26 13:46:22 +02:00
nono
3d8c22598d Update the build for the ppd files ( not needed for little printer tho ) 2025-05-26 13:45:53 +02:00
nono
b3ac0960ae Update requirements 2025-05-26 13:45:29 +02:00
4ced780d54 Added file deletion after printing. 2022-05-15 23:48:44 +02:00
277ff32b5d Changed rate limits 2022-05-15 23:34:19 +02:00
4a1b881d7b Merge branch 'master' of ssh://git.n07070.xyz:1968/n07070/littleprynter 2022-05-14 00:09:59 +02:00
ef6db806da Added a picture of the result 2022-05-14 00:08:44 +02:00
c231e38ade Added a picture of the result 2022-05-14 00:04:29 +02:00
bceaee1a10 Upated README with screenshots 2022-05-13 23:58:15 +02:00
8566eef924 CSS is hard, an image wil do the trick. 2022-05-13 23:47:17 +02:00
bbb0ed4a82 Trying to center the logo in the README 2022-05-13 23:41:31 +02:00
b41f00f412 Removed old gif, updated buttons 2022-05-10 13:30:14 +02:00
1bdd24d2dd Removed old logo 2022-05-10 00:23:10 +02:00
0a431558da Merge branch 'master' of ssh://git.n07070.xyz:1968/n07070/littleprynter 2022-05-10 00:16:32 +02:00
5b8bc067ca Added webcam support to README. 2022-05-10 00:16:17 +02:00
4df0516180 Added webcam support to README 2022-05-10 00:13:03 +02:00
9359c8e503 Merge pull request 'Webcam support to use it as a photomaton ( photobooth )' (#2) from webcam into master
Reviewed-on: http://git.n07070.xyz/n07070/littleprynter/pulls/2
2022-05-09 22:03:46 +00:00
bcb36da020 Fixed switching cameras. 2022-05-09 23:59:46 +02:00
3aa0bc7f1b Fixed buttons placement 2022-05-09 23:59:36 +02:00
10080e36f1 Updated requirements file to be compatible with futur versions. 2022-05-09 21:41:19 +02:00
5c35a8586c Move JS to another file, added printing from webcam 2022-05-09 01:50:39 +02:00
5d99e78dea Webcam buttons added, preview added 2022-05-09 01:50:18 +02:00
cd663087c8 Fixed printing images from AJAX calls 2022-05-09 01:49:57 +02:00
07e444c3b4 Mise en route plus simple 2022-05-09 01:49:35 +02:00
214d3502c0 Update requirements.txt 2022-05-09 00:51:52 +02:00
nono
27e8518be3 Update CSS 2022-05-04 21:22:22 +02:00
nono
0e6fd73ee8 Added webcam, changed rate limits, added template reload 2022-05-04 21:22:01 +02:00
nono
1d40830066 Added webcam, using partial templates 2022-05-04 21:19:22 +02:00
46 changed files with 6603 additions and 418 deletions

1
.gitignore vendored
View File

@@ -2,6 +2,7 @@
__pycache__/
*.py[cod]
*$py.class
CACHEDIR.TAG
# C extensions
*.so

View File

@@ -1,9 +1,9 @@
# Little Prynter
---
> Print out shit from the cloud on a thermal paper.
<img src="src/static/images/little-printer_banner.png" style="padding:auto">
![LittlePrynter Logo](src/static/images/little-printer.png)
> Print out shit from the cloud on a thermal paper.
## About
@@ -19,47 +19,104 @@ To make this project work, you will need :
- Some electric wires.
- Some knowledge of the command line,
- Some knowledge of Python.
- You will need to install [Poetry](https://python-poetry.org/) to manage the depedencies of the projet.
- 3h of your time, 5h if things need debugging.
- `git`, `virtualenv`,`pip` and `python` >= 3.8.6.
- You will need to following packages: `fswebcam`, `libjpeg-dev` ,`zlib1g-dev`,`libffi-dev`,`git`, `virtualenv`,`pip` and `python` >= 3.8.6.
- A webcam for the webcam page to work. Will work on a smartphone. Not required.
## Context
### Testing your printer
For the EPSON TM-T20III, you can get the CUPS driver from [here](https://download.epson-biz.com/modules/pos/index.php?page=soft&scat=32). It's not specific to the printer I've been using, so you can try with other printers.
With that, you can try out your printer and print normal text, images or pdf documents for example. LittlePrynter itself does not require any other software than the ones installed with it, i.e the ones listed in the `requirements.txt` file.
For the Adafruit printer, start by following the guide [here](https://learn.adafruit.com/networked-thermal-printer-using-cups-and-raspberry-pi) to install the CUPS software needed to print images. If you want, you can install it via the command line, [following this guide](https://help.ubuntu.com/lts/serverguide/cups.html).
With that, you can try out your printer and print normal text, images or pdf documents for example. For the Adafruit printer, start by following the guide [here](https://learn.adafruit.com/networked-thermal-printer-using-cups-and-raspberry-pi) to install the CUPS software needed to print images. If you want, you can install it via the command line, [following this guide](https://help.ubuntu.com/lts/serverguide/cups.html).
You can also get some information from [here](https://learn.adafruit.com/mini-thermal-receipt-printer) and [here](https://learn.adafruit.com/instant-camera-using-raspberry-pi-and-thermal-printer) if you're stuck.
### How LittlePrynter works
LittlePrynter itself does not require any other software than the ones installed with it, i.e the ones listed in the `pyproject.toml` file.
The version for the EPSON TM-T20III uses a library called `python-escpos`, which doesn't need a CUPS driver or anything else. It's included in the Python dependencies.
The project only supports the EPSON printer, but you can try to adapt it for other printers using the `adafruit-thermal` branch, but I won't offer support for it.
The project only supports the EPSON printer, but you can try to adapt it for other printers. For example, using `adafruit-thermal`, or `brother-ql`.
### Install & setup the project :
Theses commands will copy the software on your computer, go into the directory, then activate a virtual environnement and install all of the project's dependecies.
```
$ git clone https://git.n07070.xyz/n07070/LittlePrynter
$ virtualenv LittlePrynter
$ cd LittlePrynter
$ source bin/activate
$ pip install -r requirements.txt
$ eval "$(poetry env activate)"
$ poetry install
```
> tip : when you're done, you can get out of the virtualenv either by closing your terminal, or by running `deactivate`.
> tip : when you're done, you can get out of the poetry environnement either by closing your terminal, or by running `deactivate`.
### Configure LittlePrynter
You should see a folder named `configuration`. Enter it, and duplicate the file named `config.toml.sample`, and rename the copy to `config.toml`. Now, edit this file by following the comments in the file itself.
You should also setup the proper `udev` permissions to access the printers via USB, following the configuration found [here](https://python-escpos.readthedocs.io/en/latest/user/installation.html#setup-udev-for-usb-printers).
You can now start the web server with
```
$ export FLASK_APP=src/main.py
$ flask run
$ flask run --cert=adhoc
```
The `--cert=adhoc` argument will make LittlePrinter accessible in HTTPS with a [self-signed SSL certificate](https://en.wikipedia.org/wiki/Self-signed_certificate). This provides a free and easy way to use HTTPS, but does not provide any trust value. It is, on the other hand, a good way to access the webcam in developpement mode or on a local network, because a HTTPS connexion is required by browsers to access the needed APIs.
This command should start a web server with which you can test your configuration. If you plan on exposing your printer to the Internet, and give it an IP / URL, _please, please, please_, don't run it this way. Look at Flask's documentation and read about running a production server. It's a little more work, but it will prevent your computer/server being hacked in too easily.
Voilà !
## Contributions
Your contributions are very much welcome ! You can either request an account on git.n07070.xyz, or send me a patch by email ( see git-send-mail.io ). Please [squash](https://www.geeksforgeeks.org/git/use-of-git-squash-commits/) yours commits into one commit, and add as much information in the commit's description. The more you add comments and descriptions, the better it is.
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.
To do so, you can run the following command, which will modify your files to be in a certain coding style ;
```
black src/
```
Beware that this command *will* re-write files, so doing `git add <file>` and then `black src/` and then `git diff` to see what the linter has done is a good idea.
Then, you can run another command, called Pylint ( [documentation](https://www.pylint.org/) ) which will rate your code. Try to get 10/10 : an excellent code works better and make you a better programmer !
```
pylint src/
```
## Screenshots
![](src/static/images/homepage.png)
> The first page. You can print a picture, or a short message. It's basically exposing the API in html.
![](src/static/images/photomaton.png)
> Using the webcam via Javascript, you can print out a picture from your phone, webcam, or any other video device.
![](src/static/images/result.jpg)
## More
If you liked this project, feel free to support my work !
@@ -72,6 +129,7 @@ If you liked this project, feel free to support my work !
- [Github repo with CUPS drivers for the Adafruit Thermal Printer ( zj-58 )](https://github.com/klirichek/zj-58)
- [A link to buy one in Europe](https://rlx.sk/sk/various-boards/1829-mini-thermal-receipt-printer-adafruit-597.html)
- [Another link to buy one, direct from factory](https://www.cashinotech.com/csn-a2-58mm-mini-panel-thermal-receipt-printer_p11.html)
- [Diagnostickoeur](https://framagit.org/stickoeur/diagnostickoeur), another printer software mainly around Brother QL printers.
## Licence

View File

@@ -1,11 +1,19 @@
# Configuration file the LittlePrynter
[defaults]
signature = "Anonymous"
# Printer settings
[printer]
vendor_id = 0x04b8
device_id = 0x0e28
upload_folder = "src/static/uploads"
# Raspberry Pi Configuration
[rpi]
button_gpio_port_number = 2
indicator_gpio_port_number = 22
flash_gpio_port_number = 16
flash = true
# Users = Password
[users]
admin = "admin"

View File

@@ -1,10 +1,19 @@
# Configuration file the LittlePrynter
[defaults]
signature = "Anonymous"
# Printer settings
[printer]
vendor_id = "0x04b8"
device_id = "0x0e28"
# Raspberry Pi Configuration
[rpi]
button_gpio_port_number = 17
indicator_gpio_port_number = 18
flash = true
# Users = Password
[users]
admin = "admin"

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

View File

@@ -0,0 +1,5 @@
#cmake_minimum_required(VERSION 2.8)
add_executable(rastertotmtr
filter/TmThermalReceipt.c
)
target_link_libraries(rastertotmtr cupsimage cups)

171
docs/Thermal Receipt/EULA Normal file
View File

@@ -0,0 +1,171 @@
SEIKO EPSON CORPORATION
SOFTWARE LICENSE AGREEMENT
IMPORTANT! READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. The
computer software product, fontware, typefaces and/or data, including
any accompanying explanatory written materials (the "Software") should
only be installed or used by the Licensee ("you") on the condition you
agree with SEIKO EPSON CORPORATION ("EPSON") to the terms and
conditions set forth in this Agreement. By installing or using the
Software, you are representing to agree all the terms and conditions
set forth in this Agreement. You should read this Agreement carefully
before installing or using the Software. If you do not agree with the
terms and conditions of this Agreement, you are not permitted to
install or use the Software.
1. License. EPSON and its suppliers grant you a personal,
nonexclusive, royalty-free, non-sublicensable limited license to
install and use the Software solely for the purpose of using EPSON
printer products ("Purpose") on any single computer or computers
that you intend to use directly or via network. You may allow other
users of the computers connected to the network to use the Software,
provided that you (a) ensure that all such users agree and are bound
by the terms and conditions of this Agreement, (b) ensure that all
such users use the Software only in conjunction with the computers and
in relation to the network of which they form part, and (c) indemnify
and keep whole EPSON and its suppliers against all damages, losses,
costs, expenses and liabilities which EPSON or its suppliers may incur
as a consequence of such users failing to observe and perform the
terms and conditions of this Agreement. You may also make copies of
the Software as necessary for backup and archival purposes, provided
that the copyright notice is reproduced in its entirety on the backup
copy. The term "Software" shall include the software components,
media, all copies made by you and any upgrades, modified versions,
updates, additions and copies of the Software licensed to you by EPSON
or its suppliers. EPSON and its suppliers reserve all rights not
granted herein.
2. Other Rights and Limitations. You agree not to modify, adapt or
translate the Software. You also agree not to attempt to reverse
engineer, decompile, disassemble or otherwise attempt to discover the
source code of the Software. You may not use the Software for any
purposes other than the Purpose. You may not share, rent, lease,
encumber, sublicense or lend the Software. You may, however, transfer
all your rights to use the Software to another person or legal entity
provided that you transfer this Agreement, the Software, including all
copies, updates and prior versions, to such person or entity, and that
you retain no copies, including copies stored on a computer. Some
states or jurisdictions, however, do not allow the restriction or
limitation on transfer of the Software, so the above limitations may
not apply to you.
3. Ownership. Title, ownership rights, and intellectual property
rights in and to the Software and any copies thereof shall remain with
EPSON or its suppliers. There is no transfer to you of any title to
or ownership of the Software and this License shall not be construed
as a sale of any rights in the Software. The Software is protected by
Japanese Copyright Law and international copyright treaties, as well
as other intellectual property laws and treaties. Except as otherwise
provided in this Agreement, you may not copy the Software. You also
agree not to remove or alter any copyright and other proprietary
notices on any copies of the Software.
4. LGPL. The Software uses the open source software programs which
apply the GNU Lesser General Public License Version 2 or later version
("LGPL"). Notwithstanding any provision of this Agreement, you may
make modification of the Software for your own use and reverse
engineering for debugging such modifications according to the terms
and conditions of the LGPL.
5. Protection and Security. You agree to use your best efforts and
take all reasonable steps to safeguard the Software to ensure that no
unauthorized person has access to them and that no unauthorized copy,
publication, disclosure or distribution of any of the Software is
made. You acknowledge that the Software contains valuable,
confidential information and trade secrets, that unauthorized use and
copying are harmful to EPSON and its suppliers, and that you have a
confidentiality obligation as to such valuable information and trade
secrets.
6. Limited Warranty. In case of that you obtained the Software by
media from EPSON or a dealer, EPSON warrants that the media on which
the Software is recorded will be free from defects in workmanship and
materials under normal use for a period of 90 days from the date of
delivery to you. If the media is returned to EPSON or the dealer from
which the media was obtained within 90 days of the date of delivery to
you, and if EPSON determines the media to be defective and provided
the media was not subject to misuse, abuse, misapplication or use in
defective equipment, EPSON will replace the media, upon your return to
EPSON of the Software, including all copies of any portions thereof.
ALL IMPLIED WARRANTIES ON THE MEDIA, INCLUDING IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE LIMITED TO
THE DURATION OF THE EXPRESS WARRANTY SET FORTH ABOVE.
You acknowledge and agree that the use of the Software is at
your sole risk. THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT
ANY WARRANTY OF ANY KIND. EPSON AND ITS SUPPLIERS DO NOT AND
CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY OBTAIN BY
USING THE SOFTWARE. THE FOREGOING STATES THE SOLE AND
EXCLUSIVE REMEDIES FOR EPSON'S AND ITS SUPPLIERS' BREACH OF
WARRANTY. EXCEPT FOR THE FOREGOING LIMITED WARRANTY, EPSON
AND ITS SUPPLIERS MAKE NO WARRANTIES, EXPRESS OR IMPLIED, AS
TO NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR ANY
PARTICULAR PURPOSE. Some states or jurisdictions do not allow
the exclusion of implied warranties or limitations on how long
an implied warranty may last, so the above limitations may not
apply to you. This warranty gives you specific legal rights.
You may have other rights which vary from state to state or
jurisdiction to jurisdiction.
IN NO EVENT WILL EPSON OR ITS SUPPLIERS BE LIABLE TO YOU,
WHETHER ARISING UNDER CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY, BREACH OR WARRANTY, MISREPRESENTATION OR
OTHERWISE, FOR ANY DIRECT, CONSEQUENTIAL, INCIDENTAL OR
SPECIAL DAMAGES, INCLUDING ANY LOST PROFITS OR LOST SAVINGS,
EVEN IF EPSON, ITS SUPPLIERS OR ANY REPRESENTATIVE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM
BY ANY THIRD PARTY. Some states or jurisdictions, however, do
not allow the exclusion or limitation of incidental,
consequential or special damages, so the above limitations may
not apply to you.
7. Termination. Without prejudice to any other rights EPSON has, this
Agreement shall automatically terminate upon failure by you to comply
with its terms. You may also terminate this Agreement at any time by
uninstalling and destroying the Software and all copies thereof.
8. Export Restriction. You agree not to transfer, export or re-export
the Software and any data or information which you obtained from EPSON
or use the Software without a proper license under Japanese law,
restrictions and regulations, or the laws of the jurisdiction in which
the Software is obtained.
9. Governing Law and General Provisions. This Agreement shall be
governed and construed under by the laws of Japan without regard to
its conflicts of law rules. This Agreement is the entire agreement
between the parties with respect to the Software, and supersedes any
purchase order, communication, advertisement, or representation
concerning the Software. This Agreement shall be binding upon, and
inure to the benefit of, the parties hereto and their respective
successors, assigns and legal representatives. If any provision
herein is found void or unenforceable, it will not affect the validity
of the balance of the Agreement, which shall remain valid and
enforceable according to its terms. This Agreement may only be
modified in writing signed by an authorized officer of EPSON.
10. U.S. Government End Users. If you are acquiring the Software on
behalf of any unit or agency of the United States Government, the
following provisions apply. The Government agrees: (i) if the
Software is supplied to the Department of Defense (DoD), the Software
is classified as "Commercial Computer Software" and the Government is
acquiring only "restricted rights" in the Software and its
documentation as that term is defined in Clause 252.227-7013(c)(1) of
the DFARS; and (ii) if the Software is supplied to any unit or agency
of the United States Government other than DoD, the Government's
rights in the Software and its documentation will be as defined in
Clause 52.227-19(c)(2) of the FAR or, in the case of NASA, in Clause
18-52.227-86(d) of the NASA supplement to the FAR.
11. Internet Connection. The Software may have the ability to connect
over the Internet to transmit data and/or information to and from your
computer regarding the EPSON hardware and/or software that you use
("EPSON Products") including, but not limited to, EPSON Products model
information, the country/region where you live, the condition of EPSON
Products, etc. EPSON may alter the items of such data and/or
information without your prior approval. EPSON does not collect any
personally identifiable information without your permission. EPSON
may, however, use non personally identifiable information for
statistical purposes to improve the level of service we provide to our
users If you agree to install the Software, any transmissions to or
from the Internet will be in accordance with EPSON's then-current
Privacy Policy provided in EPSON Internet site.

View File

@@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

View File

@@ -0,0 +1,96 @@
EPSON TM Series Printer Driver for Linux Version 3.0.0
Copyright (C) Seiko Epson Corporation 2019.
1. GENERAL
----------
This software is a printer driver for printing on an Epson
TM series printer from Linux using CUPS.
1.1) Features
+ A raster type printer driver for TM series printers.
+ Can instantly print out images, texts and drawings displayed by
an application.
+ Various printer controls on paper cut timing, cash drawers,
printing speed, blank line saving, inverted printing, etc.
2. ENVIRONMENT
--------------
2.1) Supported printers
+ EPSON TM-m30
+ EPSON TM-T88VI
+ EPSON TM-H6000V
2.2) Confirmed distributions
+ Ubuntu 18.04
+ CentOS 7 1810
+ openSUSE 13.1
3. FILES
--------
+ README .......... This file
+ EULA ............ EPSON SOFTWARE LICENSE AGREEMENT
+ LISENSE ......... GNU GENERAL PUBLIC LICENSE
+ build.sh ........ Build script
+ install.sh ...... Installation script
+ CMakeList.txt ... input file of cmake
+ /filter ......... source code of filter driver
+ /ppd ............ ppd files
4. HOW TO BUILD & INSTALL
-------------------------
Ensure that you have following packages pre-installed
+ Ubuntu ..... cmake, libcupsimage2-dev development
+ CentOS ..... cmake, gcc, gcc-c++, cups-devel development
+ openSUSE ... cmake, gcc, gcc-c++, cups-devel development
4.1) Execute build script
#sudo ./build.sh
*Temporary folder build will be made when run script.
!!! You must the following install script with root privileges. !!!
4.2) Execute installation script
#sudo ./install.sh
*Filter driver and ppd files will be copied to appropriate folders.
5. HOW TO PRINT
---------------
5.1 By command line
1) Turn on printer
Turn the printer on before registering a printer.
2) Register a printer
!!! You must run lpadmin command with root privilege. !!!
#lpadmin -p <destination> -v <device-uri> -P <ppd-file> -E
-p <destination>
-v <device-uri>
-P <ppd-file>
-E
example)
#lpadmin -p TM-m10 -v usb://EPSON/TM-m10 -P tm-ba-thermal-rastertotmtr.ppd -E
3) Print a file
!!! You must always specify media options !!!
$lpr -o <option> -P <printer> <file>
example)
$lpr -o media=RP80x2000 -P TM-m10 sample.pdf
5.2 by GUI
Add a queue using OS tool & test print by GUI
http://localhost:631 or http://127.0.0.1:631
6. LIMITATIONS
--------------
+ Support USB printer class only.
Please configure printer class support manually.
7. HISTORY
----------
+ 2019/2/15 Version 3.0.0
[EOF]

11
docs/Thermal Receipt/build.sh Executable file
View File

@@ -0,0 +1,11 @@
#!/bin/sh
#build in directory
if [ -d build ]
then
rm -R build
fi
mkdir build
cd build
cmake ..
make

File diff suppressed because it is too large Load Diff

123
docs/Thermal Receipt/install.sh Executable file
View File

@@ -0,0 +1,123 @@
#!/bin/sh
echo "EPSON TM series CUPS driver installer"
echo "---------------------------------------"
echo ""
echo ""
ROOT_UID=0
if [ 0 -ne `id -u` ]
then
echo "This script requires root user access."
echo "Re-run as root user."
exit 1
fi
SERVERROOT=$(grep '^ServerRoot' /etc/cups/cupsd.conf | awk '{print $2}')
if [ -z $FILTERDIR ] || [ -z $PPDDIR ]
then
echo "Searching for ServerRoot, ServerBin, and DataDir tags in /etc/cups/cupsd.conf"
echo ""
if [ -z $FILTERDIR ]
then
SERVERBIN=$(grep '^ServerBin' /etc/cups/cupsd.conf | awk '{print $2}')
if [ -z $SERVERBIN ]
then
echo "ServerBin tag not present in cupsd.conf - using default"
FILTERDIR=/usr/lib/cups/filter
elif [ ${SERVERBIN:0:1} = "/" ]
then
echo "ServerBin tag is present as an absolute path"
FILTERDIR=$SERVERBIN/filter
else
echo "ServerBin tag is present as a relative path - appending to ServerRoot"
FILTERDIR=$SERVERROOT/$SERVERBIN/filter
fi
fi
echo ""
if [ -z $PPDDIR ]
then
DATADIR=$(grep '^DataDir' /etc/cups/cupsd.conf | awk '{print $2}')
if [ -z $DATADIR ]
then
echo "DataDir tag not present in cupsd.conf - using default"
PPDDIR=/usr/share/cups/model/EPSON
elif [ ${DATADIR:0:1} = "/" ]
then
echo "DataDir tag is present as an absolute path"
PPDDIR=$DATADIR/model/EPSON
else
echo "DataDir tag is present as a relative path - appending to ServerRoot"
PPDDIR=$SERVERROOT/$DATADIR/model/EPSON
fi
fi
echo "SERVERBIN = $SERVERBIN"
echo "FILTERDIR = $FILTERDIR"
echo "PPDDIR = $PPDDIR"
echo ""
fi
INSTALL=/usr/bin/install
echo "Installing filter driver ..."
$INSTALL -s ./build/rastertotmtr $FILTERDIR
echo ""
echo "Installing ppd files ..."
$INSTALL -m 755 -d $PPDDIR
$INSTALL -m 755 ./ppd/*.ppd $PPDDIR
echo ""
if [ -z $RPMBUILD ]
then
echo "Restarting CUPS"
if [ -x /etc/software/init.d/cups ]
then
/etc/software/init.d/cups stop
/etc/software/init.d/cups start
elif [ -x /etc/rc.d/init.d/cups ]
then
/etc/rc.d/init.d/cups stop
/etc/rc.d/init.d/cups start
elif [ -x /etc/init.d/cups ]
then
/etc/init.d/cups stop
/etc/init.d/cups start
elif [ -x /sbin/init.d/cups ]
then
/sbin/init.d/cups stop
/sbin/init.d/cups start
elif [ -x /etc/software/init.d/cupsys ]
then
/etc/software/init.d/cupsys stop
/etc/software/init.d/cupsys start
elif [ -x /etc/rc.d/init.d/cupsys ]
then
/etc/rc.d/init.d/cupsys stop
/etc/rc.d/init.d/cupsys start
elif [ -x /etc/init.d/cupsys ]
then
/etc/init.d/cupsys stop
/etc/init.d/cupsys start
elif [ -x /sbin/init.d/cupsys ]
then
/sbin/init.d/cupsys stop
/sbin/init.d/cupsys start
else
echo "Could not restart CUPS"
fi
echo ""
fi
echo "Installation Completed"
echo "Add a printer queue using OS tool, http://localhost:631, or http://127.0.0.1:631"
echo ""

View File

@@ -0,0 +1,120 @@
*PPD-Adobe: "4.3"
*% Copyright (C) Seiko Epson Corporation 2018. All rights reserved.
*%
*% PPD file for TM Series Linux CUPS Printer Driver.
*FormatVersion: "4.3"
*FileVersion: "2.0"
*LanguageVersion: English
*LanguageEncoding: ISOLatin1
*PCFileName: "EPTMBATH.PPD"
*Manufacturer: "EPSON"
*Product: "(ThermalPrinter)"
*ModelName:"EPSON TM Thermal"
*ShortNickName:"TM Thermal"
*NickName: "EPSON TM Thermal (180dpi)"
*PSVersion: "(3010.000) 0"
*LanguageLevel: "3"
*ColorDevice: False
*DefaultColorSpace: Gray
*FileSystem: False
*Throughput: "1"
*LandscapeOrientation: Plus90
*VariablePaperSize: True
*TTRasterizer: Type42
*cupsVersion: 1.2
*cupsManualCopies: True
*cupsModelNumber: 100
*cupsFilter: "application/vnd.cups-raster 0 rastertotmtr"
*cupsLanguages: "en"
*% Printer option settings
*OpenGroup: General/General
*% Page size settings.
*OpenUI *PageSize/Media Size: PickOne
*OrderDependency: 10 AnySetup *PageSize
*DefaultPageSize:RP80x200
*PageSize RP80x200/Roll paper 80 x 200 mm: "<</PageSize[205.0 566.9]/ImagingBBox null>>setpagedevice"
*PageSize RP80x2000/Roll paper 80 x 2000 mm: "<</PageSize[205.0 5669.3]/ImagingBBox null>>setpagedevice"
*PageSize RP58x200/Roll paper 58 x 200 mm: "<</PageSize[144.0 566.9]/ImagingBBox null>>setpagedevice"
*PageSize RP58x2000/Roll paper 58 x 2000 mm: "<</PageSize[144.0 5669.3]/ImagingBBox null>>setpagedevice"
*CloseUI: *PageSize
*OpenUI *PageRegion: PickOne
*OrderDependency: 10 AnySetup *PageRegion
*DefaultPageRegion:RP80x200
*PageRegion RP80x200/Roll paper 80 x 200 mm: "<</PageSize[205.0 566.9]/ImagingBBox null>>setpagedevice"
*PageRegion RP80x2000/Roll paper 80 x 2000 mm: "<</PageSize[205.0 5669.3]/ImagingBBox null>>setpagedevice"
*PageRegion RP58x200/Roll paper 58 x 200 mm: "<</PageSize[144.0 566.9]/ImagingBBox null>>setpagedevice"
*PageRegion RP58x2000/Roll paper 58 x 2000 mm: "<</PageSize[144.0 5669.3]/ImagingBBox null>>setpagedevice"
*CloseUI: *PageRegion
*DefaultImageableArea: RP80x200
*ImageableArea RP80x200/Roll paper 80 x 200 mm: "0.0 0.0 205.0 566.9"
*ImageableArea RP80x2000/Roll paper 80 x 2000 mm: "0.0 0.0 205.0 5669.3"
*ImageableArea RP58x200/Roll paper 58 x 200 mm: "0.0 0.0 144.0 566.9"
*ImageableArea RP58x2000/Roll paper 58 x 2000 mm: "0.0 0.0 144.0 5669.3"
*DefaultPaperDimension: RP80x200
*PaperDimension RP80x200/Roll paper 80 x 200 mm: "205.0 566.9"
*PaperDimension RP80x2000/Roll paper 80 x 2000 mm: "205.0 5669.3"
*PaperDimension RP58x200/Roll paper 58 x 200 mm: "144.0 566.9"
*PaperDimension RP58x2000/Roll paper 58 x 2000 mm: "144.0 5669.3"
*% Custom page size settings.
*MaxMediaWidth: "205.0"
*MaxMediaHeight: "5669.3"
*NonUIOrderDependency: 100 AnySetup *CustomPageSize
*CustomPageSize True: "pop pop pop <</PageSize [ 5 -2 roll ]/ImagingBBox null>>setpagedevice"
*ParamCustomPageSize Width: 1 points 72 205.0
*ParamCustomPageSize Height: 2 points 72 5669.3
*ParamCustomPageSize WidthOffset: 3 points 0 0
*ParamCustomPageSize HeightOffset: 4 points 0 0
*ParamCustomPageSize Orientation: 5 int 0 0
*% Resolution settings.
*OpenUI *Resolution/Resolution: PickOne
*OrderDependency: 20 AnySetup *Resolution
*DefaultResolution: 180x180dpi
*Resolution 180x180dpi/180 x 180 dpi: "<</HWResolution[180 180]/cupsRowCount 24/cupsBitsPerColor 1>>setpagedevice"
*CloseUI: *Resolution
*% Horizontal and Vertical motion units.
*TmxMotionUnitHori: "180"
*TmxMotionUnitVert: "180"
*% Paper reduction settings.
*OpenUI *TmxPaperReduction/Paper Reduction: PickOne
*OrderDependency: 30 AnySetup *TmxPaperReduction
*DefaultTmxPaperReduction: Bottom
*TmxPaperReduction Off/None: ""
*TmxPaperReduction Top/Top: ""
*TmxPaperReduction Bottom/Bottom: ""
*TmxPaperReduction Both/Top & Bottom: ""
*CloseUI: *TmxPaperReduction
*% Buzzer / Cash Drawer settings.
*OpenUI *TmxBuzzerAndDrawer/Buzzer/ Cash Drawer: PickOne
*OrderDependency: 30 AnySetup *TmxBuzzerAndDrawer
*DefaultTmxBuzzerAndDrawer: NotUsed
*TmxBuzzerAndDrawer NotUsed/Not used: ""
*TmxBuzzerAndDrawer InternalBuzzer/Internal buzzer: ""
*TmxBuzzerAndDrawer ExternalBuzzer/External buzzer: ""
*TmxBuzzerAndDrawer OpenDrawer1/Open drawer #1: ""
*TmxBuzzerAndDrawer OpenDrawer2/Open drawer #2: ""
*CloseUI: *TmxBuzzerAndDrawer
*% Paper source settings.
*OpenUI *TmxPaperCut/Paper Cut: PickOne
*OrderDependency: 30 AnySetup *TmxPaperCut
*DefaultTmxPaperCut: NoCut
*TmxPaperCut NoCut/No cut: ""
*TmxPaperCut CutPerJob/Cut per job: ""
*TmxPaperCut CutPerPage/Cut per page: ""
*CloseUI: *TmxPaperCut
*CloseGroup: General
*% End

View File

@@ -0,0 +1,120 @@
*PPD-Adobe: "4.3"
*% Copyright (C) Seiko Epson Corporation 2018. All rights reserved.
*%
*% PPD file for TM Series Linux CUPS Printer Driver.
*FormatVersion: "4.3"
*FileVersion: "2.0"
*LanguageVersion: English
*LanguageEncoding: ISOLatin1
*PCFileName: "EPTMBATH.PPD"
*Manufacturer: "EPSON"
*Product: "(ThermalPrinter)"
*ModelName:"EPSON TM Thermal"
*ShortNickName:"TM Thermal"
*NickName: "EPSON TM Thermal (203dpi)"
*PSVersion: "(3010.000) 0"
*LanguageLevel: "3"
*ColorDevice: False
*DefaultColorSpace: Gray
*FileSystem: False
*Throughput: "1"
*LandscapeOrientation: Plus90
*VariablePaperSize: True
*TTRasterizer: Type42
*cupsVersion: 1.2
*cupsManualCopies: True
*cupsModelNumber: 100
*cupsFilter: "application/vnd.cups-raster 0 rastertotmtr"
*cupsLanguages: "en"
*% Printer option settings
*OpenGroup: General/General
*% Page size settings.
*OpenUI *PageSize/Media Size: PickOne
*OrderDependency: 10 AnySetup *PageSize
*DefaultPageSize:RP80x200
*PageSize RP80x200/Roll paper 80 x 200 mm: "<</PageSize[204.3 566.9]/ImagingBBox null>>setpagedevice"
*PageSize RP80x2000/Roll paper 80 x 2000 mm: "<</PageSize[204.3 5669.3]/ImagingBBox null>>setpagedevice"
*PageSize RP58x200/Roll paper 58 x 200 mm: "<</PageSize[149.1 566.9]/ImagingBBox null>>setpagedevice"
*PageSize RP58x2000/Roll paper 58 x 2000 mm: "<</PageSize[149.1 5669.3]/ImagingBBox null>>setpagedevice"
*CloseUI: *PageSize
*OpenUI *PageRegion: PickOne
*OrderDependency: 10 AnySetup *PageRegion
*DefaultPageRegion:RP80x200
*PageRegion RP80x200/Roll paper 80 x 200 mm: "<</PageSize[204.3 566.9]/ImagingBBox null>>setpagedevice"
*PageRegion RP80x2000/Roll paper 80 x 2000 mm: "<</PageSize[204.3 5669.3]/ImagingBBox null>>setpagedevice"
*PageRegion RP58x200/Roll paper 58 x 200 mm: "<</PageSize[149.1 566.9]/ImagingBBox null>>setpagedevice"
*PageRegion RP58x2000/Roll paper 58 x 2000 mm: "<</PageSize[149.1 5669.3]/ImagingBBox null>>setpagedevice"
*CloseUI: *PageRegion
*DefaultImageableArea: RP80x200
*ImageableArea RP80x200/Roll paper 80 x 200 mm: "0.0 0.0 204.3 566.9"
*ImageableArea RP80x2000/Roll paper 80 x 2000 mm: "0.0 0.0 204.3 5669.3"
*ImageableArea RP58x200/Roll paper 58 x 200 mm: "0.0 0.0 149.1 566.9"
*ImageableArea RP58x2000/Roll paper 58 x 2000 mm: "0.0 0.0 149.1 5669.3"
*DefaultPaperDimension: RP80x200
*PaperDimension RP80x200/Roll paper 80 x 200 mm: "204.3 566.9"
*PaperDimension RP80x2000/Roll paper 80 x 2000 mm: "204.3 5669.3"
*PaperDimension RP58x200/Roll paper 58 x 200 mm: "149.1 566.9"
*PaperDimension RP58x2000/Roll paper 58 x 2000 mm: "149.1 5669.3"
*% Custom page size settings.
*MaxMediaWidth: "204.3"
*MaxMediaHeight: "5669.3"
*NonUIOrderDependency: 100 AnySetup *CustomPageSize
*CustomPageSize True: "pop pop pop <</PageSize [ 5 -2 roll ]/ImagingBBox null>>setpagedevice"
*ParamCustomPageSize Width: 1 points 72 204.3
*ParamCustomPageSize Height: 2 points 72 5669.3
*ParamCustomPageSize WidthOffset: 3 points 0 0
*ParamCustomPageSize HeightOffset: 4 points 0 0
*ParamCustomPageSize Orientation: 5 int 0 0
*% Resolution settings.
*OpenUI *Resolution/Resolution: PickOne
*OrderDependency: 20 AnySetup *Resolution
*DefaultResolution: 203x203dpi
*Resolution 203x203dpi/203 x 203 dpi: "<</HWResolution[203 203]/cupsRowCount 24/cupsBitsPerColor 1>>setpagedevice"
*CloseUI: *Resolution
*% Horizontal and Vertical motion units.
*TmxMotionUnitHori: "203"
*TmxMotionUnitVert: "203"
*% Paper reduction settings.
*OpenUI *TmxPaperReduction/Paper Reduction: PickOne
*OrderDependency: 30 AnySetup *TmxPaperReduction
*DefaultTmxPaperReduction: Bottom
*TmxPaperReduction Off/None: ""
*TmxPaperReduction Top/Top: ""
*TmxPaperReduction Bottom/Bottom: ""
*TmxPaperReduction Both/Top & Bottom: ""
*CloseUI: *TmxPaperReduction
*% Buzzer / Cash Drawer settings.
*OpenUI *TmxBuzzerAndDrawer/Buzzer/ Cash Drawer: PickOne
*OrderDependency: 30 AnySetup *TmxBuzzerAndDrawer
*DefaultTmxBuzzerAndDrawer: NotUsed
*TmxBuzzerAndDrawer NotUsed/Not used: ""
*TmxBuzzerAndDrawer InternalBuzzer/Internal buzzer: ""
*TmxBuzzerAndDrawer ExternalBuzzer/External buzzer: ""
*TmxBuzzerAndDrawer OpenDrawer1/Open drawer #1: ""
*TmxBuzzerAndDrawer OpenDrawer2/Open drawer #2: ""
*CloseUI: *TmxBuzzerAndDrawer
*% Paper source settings.
*OpenUI *TmxPaperCut/Paper Cut: PickOne
*OrderDependency: 30 AnySetup *TmxPaperCut
*DefaultTmxPaperCut: NoCut
*TmxPaperCut NoCut/No cut: ""
*TmxPaperCut CutPerJob/Cut per job: ""
*TmxPaperCut CutPerPage/Cut per page: ""
*CloseUI: *TmxPaperCut
*CloseGroup: General
*% End

Binary file not shown.

Binary file not shown.

12
littleprynter.service Normal file
View File

@@ -0,0 +1,12 @@
[Unit]
Description=LittlePrynter
After=network.target
[Service]
Type=simple
WorkingDirectory=/home/pi/littleprynter/
Environment=FLASK_APP=src/main.py
ExecStart=/home/pi/littleprynter/bin/flask run --host 0.0.0.0 --no-reload
[Install]
WantedBy=multi-user.target

View File

@@ -1 +0,0 @@
{"last_check":"2018-10-10T18:33:22Z","pypi_version":"18.1"}

1886
poetry.lock generated Normal file

File diff suppressed because it is too large Load Diff

56
pyproject.toml Normal file
View File

@@ -0,0 +1,56 @@
[project]
name = "littleprynter"
version = "0.1.0"
description = "A web interface and API to print on thermal printers"
authors = [
{name = "n07070",email = "contact@n07070.xyz"}
]
license = "AGPLv3"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
"flask (>=3.1.3,<4.0.0)",
"numpy (>=2.3.4)",
"toml (>=0.10.2,<0.11.0)",
"flask-socketio (>=5.6.1,<6.0.0)",
"flask-limiter (>=4.1.1,<5.0.0)",
"gpiozero (>=2.0.1)",
"cryptography (>=48.0.0,<49.0.0)",
"pyusb (>=1.3.1,<2.0.0)",
"pyserial (>=3.5,<4.0)",
"qrcode (<9.0)",
"python-barcode (>=0.16.1)",
"setuptools (==81)",
"cffi (>=2.0.0,<3.0.0)",
"configobj (>=5.0.9,<6.0.0)",
"future (>=1.0.0,<2.0.0)",
"h11 (>=0.16.0,<0.17.0)",
"idna (>=3.15,<4.0)",
"itsdangerous (>=2.2.0,<3.0.0)",
"jinja2 (>=3.1.6,<4.0.0)",
"jsonpointer (>=3.1.1,<4.0.0)",
"jsonschema (>=4.26.0,<5.0.0)",
"limits (>=5.8.0,<6.0.0)",
"markupsafe (>=3.0.3,<4.0.0)",
"pillow (>=12.2.0,<13.0.0)",
"pycryptodomex (>=3.23.0,<4.0.0)",
"python-dateutil (>=2.9.0.post0,<3.0.0)",
"python-engineio (>=4.13.1,<5.0.0)",
"python-socketio (>=5.16.1,<6.0.0)",
"pyyaml (>=6.0.3,<7.0.0)",
"requests (>=2.34.2,<3.0.0)",
"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]
package-mode = false
[tool.poetry.dependencies]
python-escpos = {allow-prereleases = true}
[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
build-backend = "poetry.core.masonry.api"

View File

@@ -1,13 +0,0 @@
Adafruit-Thermal>=1.1.0
Click>=7.0
Flask>=1.0.2
Flask-Limiter>=1.0.1
itsdangerous>=0.24
Jinja2>=2.10
limits>=1.3
MarkupSafe>=1.0
Pillow>=5.3.0
pyserial>=3.4
six>=1.11.0
Unidecode>=1.0.22
Werkzeug>=0.14.1

3
run.sh
View File

@@ -1,3 +0,0 @@
export FLASK_APP=src/main.py
export FLASK_ENV=development
flask run --host 192.168.0.42 --debugger --eager-loading

View File

@@ -1,77 +1,226 @@
# Welcome to the LittlePrynter's source code.
# This program expose a web interface, with user authentification, that makes it possible to print messages from the web.
# It also exposes a API, making it possible to print and interface with much of the printer's abilities.
"""
Welcome to the LittlePrynter's source code.
This program expose a web interface, with user authentification,
that makes it possible to print messages from the web.
It also exposes a API, making it possible to print and interface
with much of the printer's abilities.
# We first define the connection to the printer itself,
# Then we build the API around Flask,
# Then we build the web interface, using the simple Jinja2 templating.
We first define the connection to the printer itself,
Then we build the API around Flask,
Then we build the web interface, using the simple Jinja2 templating.
We support two modes :
The first is a simple mode, where a computer, connected to a thermal printer,
runs this program and exposes a web interface that makes use of the client's camera
The seconde is booth mode, where a Raspberry Pi is connected to a thermal printer,
a button and a flash.
The web interface exists but may not be used, as the press of the button with take
a picture and activate the flash while simply informing the web page.
"""
# Following are the librairies we import,
from flask import Flask, request, render_template, flash, abort, redirect, url_for, make_response, jsonify # Used for the web framework
import sys
import os # For VARS from the shell.
import pprint # To pretty print JSON
import toml # Used for the config file parsing
from flask import (
Flask,
request,
render_template,
flash,
redirect,
url_for,
jsonify,
) # Used for the web framework
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
import toml # Used for the config file parsing
import pprint # To pretty print JSON
import time # To sleep
import os # For VARS from the shell.
# Variables
from print_queue import PrintQueue
from worker import PrintWorker
# We create the main Flask object
app = Flask(__name__)
socketio = SocketIO(app, cors_allowed_origins="*")
# Global variables
ALLOWED_EXTENSIONS = {"png", "jpg", "jpeg", "gif", "webp"}
# Load the configuration file
try:
app.logger.debug("Loading config file...")
configuration_file = toml.load("configuration/config.toml")
with open("configuration/config.toml", "r", encoding="utf-8") as f:
configuration_file = toml.load(f)
except TypeError:
app.logger.error("Unable to load the config file: invalid type or is a list containing invalid types")
exit(-1)
except toml.TomlDecodeError:
app.logger.error("An error occured while decoding the file")
exit(-1)
except Exception as e:
app.logger.error("Error while loading file : " + str(e))
exit(-1)
app.logger.error(
"Unable to load the config file: invalid type or is a list containing invalid types"
)
sys.exit(-1)
except toml.TomlDecodeError as e:
app.logger.error(
"An error occured while decoding the file %s , error at %s:%s",
str(e.doc),
str(e.colno),
str(e.lineno),
)
sys.exit(-1)
except OSError as e:
app.logger.error("Error while loading file %s ", str(e))
sys.exit(-1)
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"])
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'}
UPLOAD_FOLDER = str(configuration_file["printer"]["upload_folder"])
try:
os.mkdir(UPLOAD_FOLDER)
app.logger.debug("Directory %s created successfully.", UPLOAD_FOLDER)
except FileExistsError:
app.logger.debug("Directory %s already exists.", UPLOAD_FOLDER)
except PermissionError:
app.logger.error("Permission denied: Unable to create %s", UPLOAD_FOLDER)
sys.exit(77)
# Output the config file
if os.getenv('LIPY_DEBUG') == 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'] = 3 * 1000 * 1000 # Maximum 3Mb for a file upload
app.config["UPLOAD_FOLDER"] = UPLOAD_FOLDER
app.config["ALLOWED_EXTENSIONS"] = ALLOWED_EXTENSIONS
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)
# Web routes
web = Web(app, printer)
limiter = Limiter(
# Find out if we are running on a Raspberry Pi
rpi = Raspberry(
print_queue,
app,
key_func=get_remote_address,
default_limits=["200 per day", "50 per hour"]
configuration_file
)
RASPBERRY_PI_CONNECTED = rpi.is_raspberry_pi()
# Web & API management
web = Web(app, print_queue)
# 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.route('/')
app.logger.info("🖶 Welcome to LittlePrynter !")
# General routes
@app.route("/")
@limiter.limit("1/second", override_defaults=False)
def index():
"""Return the web interface index"""
app.logger.debug("Loading index")
return render_template('index.html')
return render_template("index.html")
@app.route("/webcam")
@limiter.limit("1/second", override_defaults=False)
def webcam():
"""Returns the webcam web interface"""
app.logger.debug("Loading webcam interface")
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
@@ -79,91 +228,183 @@ def index():
# api/auth/{login,logout}
# api/status/{paper,ping,stats}
# If you just call the api route, you get a help back.
@app.route('/api')
@app.route('/api/print')
@app.route("/api")
@app.route("/api/print")
@limiter.limit("1/second", override_defaults=False)
def api_index():
"""Returns a how-to for the API"""
app.logger.debug("Loading API")
return render_template("api.html")
@app.route('/api/print/sms', methods=['POST'])
@limiter.limit("2/minute", override_defaults=False)
@app.route("/api/print/sms", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False)
def api_print_sms():
app.logger.debug("Printing an sms")
"""Prints a short message on a printer"""
app.logger.debug("Printing an sms via API")
try:
txt = request.form["txt"]
sign = request.form["signature"]
except Exception as e:
flash(e,'error')
redirect(url_for('index'))
except werkzeug.exceptions.BadRequestKeyError as e:
app.logger.error("Whoops, we are missing the txt input field. : %s ", str(e))
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. : %s", str(e)
)
sign = configuration_file["defaults"]["signature"]
try:
# comment: We try to print the SMS
web.print_sms(txt, sign)
except Exception as e:
pass
except RuntimeError as e:
return str(e), 500
# end try
return "OK", 200
return redirect(url_for('index'))
@app.route('/api/print/img', methods=['POST'])
@limiter.limit("2/minute", override_defaults=False)
@app.route("/api/print/img", methods=["POST"])
@limiter.limit("6/minute", override_defaults=False)
def api_print_image():
app.logger.debug("Printing an image")
"""Prints an image on a printer"""
app.logger.debug("Printing an image via API")
try:
# comment: We try to get a signature
sign = request.form["signature"]
except Exception as e:
flash(str(e),'error')
redirect(url_for('index'))
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"]
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.")
return "No image submitted", 400
if 'img' not in request.files:
flash('No file found. Did you use the good form ?', 'error')
return redirect(url_for("index"))
else:
file = request.files['img']
# If the user does not select a file, the browser submits an
# empty file without a filename.
if file.filename == '':
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 !")
flash('No file submitted, please select a file','error')
return redirect(url_for("index"))
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:
pass
except RuntimeError as e:
return str(e), 500
return "OK", 200
# 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 on a raspberry pi"""
if RASPBERRY_PI_CONNECTED:
try:
return rpi.camera_picture()
except RuntimeError as e:
return jsonify({"message": "Error getting the stream : " + e}), 500
else:
flash('Cannot access to page with this method.','error')
app.logger.debug('Bad access type to this API.')
return jsonify({"message": "No camera present"}), 500
return redirect(url_for("index"))
@app.route('/login')
@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')
@app.route("/logout")
@limiter.limit("1/second", override_defaults=False)
def logout_page():
"""Unused, logout"""
# web.logout(username, password)
return redirect(url_for("index"))
return redirect(url_for("index")), 501
@app.errorhandler(429)
def ratelimit_handler(e):
flash("Rate limit reached, please slow down :) ( Currently at "+ e.description + ")", 'error')
"""Handle rate limits"""
flash(
"Rate limit reached, please slow down :) ( Currently at " + e.description + ")",
"error",
)
app.logger.debug("Rate limit reached %s ", str(e.description))
return redirect(url_for("index"))
@app.route("/ping")
@limiter.exempt
def ping():
flash("🏓 Pong !",'info')
"""Returns a pong"""
flash("🏓 Pong !", "info")
app.logger.debug("🏓 Pong !")
return redirect(url_for("index"))
@socketio.on("ping")
def handle_message(data):
"""Handle sockets pings"""
app.logger.debug("Received : %s ", str(data))
socketio.emit("pong", "Pong !")
@socketio.on("get_camera_status")
def camera_status():
"""Returns camera status to a socket"""
app.logger.debug("Client asked if we had a camera")
if RASPBERRY_PI_CONNECTED:
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,178 +1,597 @@
# Importing the module to mage the connection to the printer.
from flask import flash
from escpos.printer import Usb, USBNotFoundError
from time import sleep, gmtime, strftime
"""
This class manages connexion to a Printer
"""
import os.path
from PIL import Image
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.usb_args = {}
self.usb_args['idVendor'] = self.device_id
self.usb_args['idProduct'] = self.vendor_id
self.device_id = device_id
self.ready = False
self.printer_type = printer_type
self._lock = threading.Lock()
def check_paper(self) -> bool:
# Let's check paper status
self.app.logger.debug('Checking paper status...')
@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.vendor_id
self.usb_args["idProduct"] = self.device_id
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))
try:
if p.is_online():
self.app.logger.debug("Printer online !")
except Exception as e:
raise e
# Setting up the printing options.
p.set(
align="center",
font="a",
bold=False,
underline=0,
width=1,
height=1,
density=9,
invert=False,
smooth=False,
flip=False,
double_width=False,
double_height=False,
custom_size=False,
)
# 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
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...')
flash("No more paper on the printer. Sorry.",category='error')
self.app.logger.error("Printer has no more paper, aborting...")
self.printer.close()
return False
raise RuntimeError("No more paper in the printer")
case 1:
self.app.logger.warning('Printer needs paper to be changed very soon ! ')
flash('Printer needs paper to be changed very soon ! ', category='info')
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.app.logger.debug("Printer has paper, good to go")
self.printer.close()
return True
def init_printer(self):
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
# 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 = Usb(self.device_id, self.vendor_id, 0, profile="TM-P80")
except USBNotFoundError 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 = 30 # Reset the waiting time for the next print.
return False
# Setting up the printing options.
p.set(align='center', font='a', bold=False, underline=0, width=1, height=1, density=9, invert=False, smooth=False, flip=False, double_width=False, double_height=False, custom_size=False)
# Beware : if we print every time the printer becomes ready, it means
# we are printing before and after every print !
self.printer = p
self.ready = True;
self.printer.close();
if not self.check_paper():
return False
return True
def print_sms(self, msg, signature) -> bool:
clean_msg = str(msg)
# We make sure that the signature is not something too goofy
clean_msg = str(msg) + "\n"
clean_signature = str(signature)
if not self.check_paper():
return False
# 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 RuntimeError(
"Could not print message of this length :"
+ str(len(clean_msg))
+ ", needs to be below 4096 caracters long."
)
if len(clean_msg) > 256 or len(clean_msg) < 3 :
self.app.logger.warning("Could not print message of this length: " + str(len(clean_msg)))
flash("Could not print message of this length :" + str(len(clean_msg)) + ", needs to between 3 and 256 caracters long.",category='error')
return False
if len(signature) > 256:
self.app.logger.warning(
"Could not print signature of this length: " + str(len(clean_signature))
)
raise RuntimeError(
"Could not print signature of this length :"
+ str(len(clean_signature))
+ ", needs to be below 256 caracters long."
)
if len(signature) > 256 or len(signature) < 3:
self.app.logger.warning("Could not print message without a signature.")
flash("Could not print message without a signature.",category='error')
return False
if not os.getenv('LIPY_DEBUG') == True:
# 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='left', font='a', bold=False, underline=0, width=1, height=1, density=8, invert=False, smooth=True, flip=False, double_width=False, double_height=False, custom_size=False)
self.printer.open(self.usb_args)
self.printer.set(align="center", font="a", bold=bold)
self.printer.textln(clean_msg)
self.printer.set(align='left', font='b', bold=False, underline=1, width=1, height=1, density=9, invert=False, smooth=True, flip=False, double_width=False, double_height=False, custom_size=False)
self.printer.textln("> " + clean_signature + " @ " + strftime("%Y-%m-%d %H:%M:%S", gmtime()))
self.printer.cut()
self.printer.close
if clean_signature:
self.printer.textln(clean_signature)
self.printer.textln()
self.printer.close()
except Exception as e:
flash("Unable to print because : " + 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
flash("Message printed : " + clean_msg ,category='info')
return True
self.app.logger.info("Printed text")
self.ready = True
def print_img(self, path, sign):
clean_signature = str(sign)
def _print_img(self, path, signature="", center=True, process=False):
self.ready = False
clean_signature = str(signature)
if len(signature) > 256:
self.app.logger.warning(
"Could not print signature of this length: " + str(len(clean_signature))
)
raise ValueError(
"Could not print signature of this length :"
+ str(len(clean_signature))
+ ", needs to be below 256 caracters long."
)
if not os.path.isfile(str(path)):
self.app.logger.warning("File does not exist : " + str(path))
flash('The file path for this image :' + str(path) + " wasn't found. Please try again.", 'error')
return False
else:
raise OSError(
"The file path for this image :"
+ str(path)
+ " wasn't found. Please try again."
)
self.app.logger.debug("Printing file from " + str(path))
if process:
try:
self.app.logger.debug("Resizing the image")
with Image.open(path) as im:
basewidth = 575
img = Image.open(path)
wpercent = (basewidth/float(img.size[0]))
hsize = int((float(img.size[1])*float(wpercent)))
img = img.resize((basewidth,hsize), Image.ANTIALIAS)
if img.height > 1000:
flash("Image is too long, sorry ! Keep it below 500×1000 pixels.",'error')
return False
img.save(path)
except Exception as e:
flash(str(e))
self.app.logger.error(str(e))
self.app.logger.debug("Proccessing the image")
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.textln("> " + clean_signature + " @ " + strftime("%Y-%m-%d %H:%M:%S", gmtime()))
self.printer.image(path)
self.printer.image(processed_path, center=center)
self.printer.textln(signature)
self.printer.close()
self.app.logger.debug("Printed an image : " + str(processed_path))
except Exception as e:
self.app.logger.error(str(e))
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")
self.ready = True
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 RuntimeError as e:
self.printer.close()
self.app.logger.error(str(e))
raise e
self.app.logger.info("Printed a QR")
self.ready = True
def _cut(self):
self.ready = False
try:
self.printer.open(self.usb_args)
self.printer.cut()
self.printer.close()
self.app.logger.debug("Printed an image : " + str(path))
return True
except Exception as e:
self.printer.close()
flash(str(e),'error')
return False
self.app.logger.error(str(e))
raise e
self.app.logger.info("Did a cut")
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"""
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 = 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 from RGBA to RGBA")
original_img = original_img.convert("RGB")
# Resize while maintaining aspect ratio
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)
# self.app.logger.debug("Dithered the image")
# Compute brightness of original image (grayscale average)
grayscale = original_img.convert("L")
avg_brightness = np.array(grayscale).mean()
self.app.logger.debug(
"Average brightness of the image : " + str(avg_brightness)
)
# Dynamically compute brightness factor if too dark
if avg_brightness < brightness_threshold:
brightness_factor = (
1 + (brightness_threshold - avg_brightness) / brightness_threshold
)
brightness_factor = min(
max(brightness_factor, 1.1), 2.5
) # Clamp between 1.1 and 2.5
self.app.logger.debug(
f"Image too dark, increasing brightness by a factor of {brightness_factor:.2f}"
)
enhancer = ImageEnhance.Brightness(grayscale)
grayscale = enhancer.enhance(brightness_factor)
# 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"
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

300
src/raspberry.py Normal file
View File

@@ -0,0 +1,300 @@
"""
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:
"""
This class will manage three things :
- Connecting to a USB webcam
- Managing a push button
- Activating a flash ( or light )
- Flash an indicator light
# pylint: disable=too-many-instance-attributes
# dede
"""
def __init__(
self,
print_queue,
app,
configuration_file
):
self.print_queue = print_queue
self.app = app
self.configuration_file = configuration_file
self.image_path = self.app.config["UPLOAD_FOLDER"] + "/image.jpg"
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", encoding="utf-8") as cpuinfo:
found = False
for line in cpuinfo:
if line.startswith("Hardware"):
found = True
label, value = line.strip().split(":", 1)
value = value.strip()
if value not in (
"BCM2708",
"BCM2709",
"BCM2711",
"BCM2835",
"BCM2836",
):
self.app.logger.debug(
"This system does not appear to be a Raspberry Pi."
)
return False
if not found:
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`.")
return False
self.app.logger.debug("It seems we are on a Raspberry Pi")
try:
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):
"""
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.configuration_file["rpi"]["indicator_gpio_port_number"])
self.app.logger.debug("Activated indicator LED")
self.indicator_countdown(iters=3)
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.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)
self.led.off()
sleep(i / multi)
def indicator_led(self, timing=0.2, l=5):
"""
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)
self.led.off()
self.app.logger.debug("LED turned off")
sleep(timing)
def flash_toggle(self):
"""
Flashes the flash
"""
self.app.logger.debug("Flash turned on")
self.flash.on()
sleep(0.3)
self.flash.off()
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(
f"Invalid directory for image path: {self.image_path}"
)
return False
try:
result = subprocess.run(
["fswebcam", "--no-banner", "-r", "1920x1080", self.image_path],
check=True, # Will raise CalledProcessError if the command fails
stdout=subprocess.PIPE, # Capture standard output
stderr=subprocess.PIPE, # Capture error output
)
# Optionally log the command output
self.app.logger.debug(
f"Image captured successfully: {result.stdout.decode()}"
)
except subprocess.CalledProcessError as e:
# Log error output if available
self.app.logger.error(
f"Unable to take a picture. Error: {e.stderr.decode()}"
)
return False
except RuntimeError as e:
# Catch any unexpected errors
self.app.logger.error(f"Unexpected error while taking picture: {str(e)}")
return False
# # Overlay logo
# logo_path = 'src/static/images/requin.png' # Update path as needed
# if not self.overlay_logo(self.image_path, logo_path):
# self.app.logger.warning("Picture taken but failed to overlay logo.")
return True
def overlay_logo(
self,
image_path,
logo_path,
output_path=None,
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")
# Resize logo if it's too big (logo will be 30% the width of the image)
logo_ratio = (
0.30 # You can change the ratio if you want the logo bigger or smaller
)
logo_width = int(image.width * logo_ratio)
logo_height = int(logo.height * (logo_width / logo.width))
logo = logo.resize((logo_width, logo_height), Image.Resampling.LANCZOS)
# Calculate position based on the chosen location
if position == "bottom_right":
x = image.width - logo.width - margin
y = image.height - logo.height - margin
elif position == "top_left":
x, y = margin, margin
elif position == "top_right":
x = image.width - logo.width - margin
y = margin
elif position == "bottom_left":
x = margin
y = image.height - logo.height - margin
else:
raise ValueError(
"Invalid position." +
"Choose from 'bottom_right', 'top_left', " +
" 'top_right', or 'bottom_left'."
)
# Composite the logo onto the image
image.paste(logo, (x, y), logo) # Use logo as its own alpha mask
# Save the result
if not output_path:
output_path = image_path # Overwrite the original image if no output path is given
image.save(output_path)
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
# Determine shorter side
new_edge = min(width, height)
# Calculate cropping box (centered)
left = (width - new_edge) // 2
top = (height - new_edge) // 2
right = left + new_edge
bottom = top + new_edge
image = image.crop((left, top, right, bottom))
if not output_path:
output_path = image_path # Overwrite original
image.save(output_path)
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")
self.indicator_countdown(
iters=4, multi=20
) # The indicator will flash a countdown LED
self.app.logger.debug("Taking picture")
try:
self.flash.on()
self.take_picture()
except RuntimeError as e:
self.app.logger.error(
"Could not take a picture after the button press : " + str(e)
)
finally:
self.flash.off()
self.app.logger.debug("Printing picture")
self.led.on()
self.crop_to_square(self.image_path)
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("Added a photomaton picture to the print queue")
return True

View File

@@ -1,10 +1,36 @@
body {
/* body {
margin-left: 20%;
margin-right: 20%;
} */
html, body {
height: 100%;
width: 100%;
}
button {
margin-top: 3em;
.fullscreen-countdown {
position: fixed;
top: 0;
left: 0;
right: 0;
bottom: 0;
z-index: 100;
height: 100%;
width: 100%;
/* backdrop-filter: blur(10px); */
color: black;
box-sizing: initial;
}
#countdown-number {
font-weight: bolder;
font-size: 10em;
text-shadow: 0px 0px 3em white, 1px 1px 1px rgba(255, 255, 255, 1);
position: fixed;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
}
/*// Small devices (landscape phones, 576px and up)*/
@@ -14,8 +40,8 @@ button {
/*// Medium devices (tablets, 768px and up)*/
@media (min-width: 768px) {
margin-left: 0%;
margin-right: 0%;
margin-left: 0;
margin-right: 0;
}
/*// Large devices (desktops, 992px and up)*/

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

348
src/static/js/webcam.js Normal file
View File

@@ -0,0 +1,348 @@
let streaming;
var current_stream;
var current_camera_is;
var supports_facing_mode;
var camera_options;
var width = document.getElementById("video").parentNode.parentElement.clientWidth;
var height = width / (4 / 3);
var socket = io();
socket.on('connect', function() {
socket.emit('ping', {data: 'I\'m connected!'});
console.log("Sent a ping to the server :)");
});
socket.on('pong', () => {
console.log('Received pong back ! ');
});
socket.on('new_image', () => {
console.log("Received new image event");
const img = document.getElementById('snapshot');
img.src = '/image?' + new Date().getTime(); // Bust cache
});
async function startup(){
video = document.getElementById('video');
canvas = document.getElementById('canvas');
photo = document.getElementById('photo');
switch_cameras = document.getElementById('flip')
printButton = document.getElementById('print_button');
console.log("Checking for client webcam capabilities");
// We have a camera_options dictionnary in return, or false if the device does not support webcams.
let client_webcam_capabilities = await check_webcam_capabilies();
if ( client_webcam_capabilities != false ){
get_webcam(client_webcam_capabilities);
setup_events();
clear_canvas();
} else {
console.log("Checking for server webcam capabilities");
let server_webcam_capabilities = await check_server_camera();
if (server_webcam_capabilities === true ){
console.log("The server has a camera, using it.");
console.log("TODO");
}
else {
no_webcam_error();
console.log("Seems like it's impossible to get a webcam from the client nor the server.");
}
}
}
async function check_webcam_capabilies(){
console.log("Checking for a the capabilities of the client's media devices");
// We try to start with the front facing camera,
// if we have no support, we switch back to a normal camera.
try {
// We first check if the navigator has a media device
if (!navigator.mediaDevices?.enumerateDevices) {
console.log("enumerateDevices() not supported.");
return false;
} else {
// List cameras and microphones.
console.log("The device has the following media devices : ")
await navigator.mediaDevices
.enumerateDevices()
.then((devices) => {
devices.forEach((device) => {
console.log(`${device.kind}: ${device.label} id = ${device.deviceId}`);
});
})
.catch((err) => {
console.error(`${err.name}: ${err.message}`);
return false;
});
}
} catch (e) {
console.log("The device does not seem to support webcams " + e);
return false;
}
console.log("Checking for the supported constraints of the media devices ");
try {
const supports = navigator.mediaDevices.getSupportedConstraints();
if (!supports['facingMode']) {
throw new Error("This browser does not support facingMode!");
} else {
console.log("The device supports facing mode, selecting the front camera by default");
supports_facing_mode = true;
camera_options = {
video: {
facingMode: 'user', // Or 'environment' if we want a camera facing away
},
audio: false
};
return camera_options;
}
} catch (e) {
console.log("Resetting to default camera : " + e);
supports_facing_mode = false;
camera_options = {
video: true,
audio: false
};
return camera_options
}
}
async function get_webcam(options){
stop_video_streams();
try {
navigator.mediaDevices.getUserMedia(options)
.then(function(stream) {
// on success, stream it in video tag
// the video tag is hidden, as is the canvas.
console.log("Got the webcam stream");
printButton.removeAttribute("disabled","");
current_stream = stream;
video.srcObject = stream;
video.setAttribute('autoplay', '');
video.setAttribute('muted', '');
video.setAttribute('playsinline', '')
video.play();
return true;
})
.catch(function(err) {
console.log("Didn't manage to get a camera :" + err);
return false;
});
} catch (err) {
console.log("Didn't manage to get a camera :" + err);
return false;
}
}
async function check_server_camera(){
console.log("Checking for a camera on the server");
await socket.emit('get_camera_status', (response) => {
if (response){
console.log("Server has a camera !");
return true;
} else {
console.log("The server doesn't seem to have a camera");
return false;
}
});
}
function setup_events(){
// When the video is ready, we start streaming it to the canvas.
// The canvas is hidden, but it still exists in the browser.
video.addEventListener('canplay', function(ev) {
if (!streaming) {
height = video.videoHeight / (video.videoWidth / width);
if (isNaN(height)) {
height = width / (4 / 3);
}
video.setAttribute('width', width);
video.setAttribute('height', height);
canvas.setAttribute('width', width);
canvas.setAttribute('height', height);
photo.setAttribute('width', width);
photo.setAttribute('height', height);
streaming = true;
printButton.removeAttribute("disabled","");
switch_cameras.removeAttribute("disabled","");
}
}, false);
switch_cameras.addEventListener('click', function(ev) {
flip_cameras();
}, false );
printButton.addEventListener('click', async function(ev) {
ev.preventDefault();
try {
await countDownToPicture(); // wait for countdown to finish
var data = await take_picture(); // take_picture can be async
print_picture(data);
} catch (e) {
alert("Failed to print a picture because : " + e);
}
}, false);
}
function clear_canvas() {
var context = canvas.getContext('2d');
context.fillStyle = "#AAA";
context.fillRect(0, 0, canvas.width, canvas.height);
var data = canvas.toDataURL('image/png');
photo.setAttribute('src', data);
}
function dataURLtoFile(dataurl, filename) {
if(dataurl === "") {
console.log("We didn't receive data");
}
var arr = dataurl.split(','), mime = arr[0].match(/:(.*?);/)[1],
bstr = atob(arr[1]), n = bstr.length, u8arr = new Uint8Array(n);
while(n--){
u8arr[n] = bstr.charCodeAt(n);
}
return new File([u8arr], filename, {type:mime});
}
async function take_picture() {
const context = canvas.getContext('2d');
let data = null;
if (width && height) {
canvas.width = width;
canvas.height = height;
context.drawImage(video, 0, 0, width, height);
data = canvas.toDataURL('image/png');
photo.setAttribute('src', data);
} else {
clear_canvas();
}
return data;
}
function print_picture(data){
var url = "/api/print/img"
var picture = dataURLtoFile(data);
const formData = new FormData();
let currentDate = new Date();
let time = currentDate.getHours() + ":" + currentDate.getMinutes() + ":" + currentDate.getSeconds();
formData.set("img", picture, "picture.png");
formData.set("signature", "Webcam")
fetch(url, {
method: 'POST', // or 'PUT'
body: formData,
// headers:{
// 'Content-Type': 'multipart/form-data'
// }
}).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);
}
function flip_cameras(){
console.log("Current facing mode : " + camera_options.video.facingMode)
if ( supports_facing_mode ) {
console.log("Support facing mode, trying to switch !");
if (camera_options.video.facingMode == 'user'){
camera_options = { audio: false, video: { facingMode: "environment" },};
} else {
camera_options = { audio: false, video: { facingMode: "user" },};
}
}
console.log("Switching to " + camera_options.video.facingMode );
get_webcam(camera_options);
}
function stop_video_streams(){
console.log("Stopping existing video streams.");
// Stop the tracks
try {
if (current_stream) {
const tracks = current_stream.getTracks();
tracks.forEach(track => track.stop());
console.log("Stopped playing current videostreams.");
return true;
} else {
console.log("No streams currently playing.");
}
} catch (e) {
console.log("Could not stop playing current streams." + e);
}
}
function no_webcam_error(){
console.log("Seems like they is no webcam available.")
// We disable the print button is it cannot be clicked.
printButton.setAttribute("disabled","");
// We create an alert message.
const frame_div = document.getElementById("image_dither");
frame_div.removeAttribute('class');
const alert_div = document.createElement("div");
alert_div.setAttribute("class", "alert alert-warning");
alert_div.setAttribute("role", "alert");
var alert_message = document.createTextNode("We where unable to get a Webcam device, this page will not work.");
alert_div.appendChild(alert_message);
frame_div.appendChild(alert_div);
throw new Error("Unable to get a video device, stopping the photobooth.");
}
async function countDownToPicture(){
return new Promise((resolve) => {
console.log("Starting countdown");
// We create full-page overlay that displays a number to countdown until the picture is taken.
const countdown_div = document.getElementById("countdown");
countdown_div.style.display = "block";
// Set the different styling attributes of the element
countdown_div.setAttribute("class", "fullscreen-countdown");
// The loop must run for 3 seconds
interval = 1000;
var loops = 3;
var x = setInterval(() => {
console.log(loops);
// Update the content of the div
document.getElementById("countdown-number").innerHTML = loops;
if (loops == 0) {
countdown_div.style.display = "none";
// The timer has finished
clearInterval(x);
resolve();
}
loops--;
}, interval);
});
}
window.addEventListener('load', startup, false);

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

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

21
src/templates/banner.html Normal file
View File

@@ -0,0 +1,21 @@
<body class="container">
<div class="col-md-7 offset-md-2">
<a href="/"><img class="rounded" width="100px" src="{{ url_for('static', filename='images/little-printer.png') }}" alt="LittlePrynter icon"></a><h1 class="card-title font-weight-bold">Little Prynter</h1>
<hr>
<div class="alert alert-dark" role="alert">LittlePrynter is under heavy developpement, you may encounter bugs ! If so, try again. Thanks !</div>
<br>
{% with messages = get_flashed_messages(category_filter=('error')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-danger" role="alert">⚠️ {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
{% with messages = get_flashed_messages(category_filter=('info')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-info" role="alert"> {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}

61
src/templates/base.html Normal file
View File

@@ -0,0 +1,61 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LittlePrynter</title>
<link rel="shortcut icon" href="{{ url_for('static', filename='favicon.ico') }}">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link href="{{ url_for('static', filename='css/bootstrap.min.css') }}" rel="stylesheet">
<link rel="stylesheet" href="{{ url_for('static',filename='css/style.css') }}">
</head>
<body class="container">
<div class="col-auto">
<a href="/"><img class="rounded" width="100px" src="{{ url_for('static', filename='images/little-printer.png') }}" alt="LittlePrynter icon"></a><h1 class="card-title font-weight-bold">Little Prynter</h1>
<hr>
<nav class="navbar navbar-expand-lg navbar-light bg-light">
<div class="container-fluid">
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item">
<a class="nav-link active" aria-current="page" href="/">Home</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/webcam">Webcam</a>
</li>
</ul>
</div>
</nav>
<br>
<div class="alert alert-dark" role="alert">LittlePrynter is under heavy developpement, you may encounter bugs ! If so, try again. Thanks !</div>
<br>
{% with messages = get_flashed_messages(category_filter=('error')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-danger" role="alert">⚠️ {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
{% with messages = get_flashed_messages(category_filter=('info')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-info" role="alert"> {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
{% block content %}
{% endblock %}
<hr>
<footer class="row">
<p class=" text-center">Little Prynter is built by <a href="https://n07070.xyz/about-me/">n07070</a> because it's fun :) | <a href="https://git.n07070.xyz/n07070/littleprynter">Source code - AGPLv3</a></p>
</footer>
</body>
<script src="https://cdn.socket.io/4.0.0/socket.io.min.js"></script>
</html>

View File

@@ -0,0 +1,5 @@
<hr>
<footer>Little Prynter is built by <a href="https://n07070.xyz/about-me/">n07070</a> because it's fun :) | <a href="https://git.n07070.xyz/n07070/littleprynter/src/branch/epson-tm-t20iii">Source code - AGPLv3</a></footer>
</div>
</body>
</html>

View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LittlePrynter</title>
<link rel="shortcut icon" href="{{ url_for('static', filename='favicon.ico') }}">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link href="{{ url_for('static', filename='css/bootstrap.min.css') }}" rel="stylesheet">
<link rel="stylesheet" href="{{ url_for('static',filename='css/style.css') }}">
</head>

View File

@@ -1,48 +1,14 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>LittlePrynter</title>
<link rel="shortcut icon" href="{{ url_for('static', filename='favicon.ico') }}">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link href="{{ url_for('static', filename='css/bootstrap.min.css') }}" rel="stylesheet">
<link rel="stylesheet" href="{{ url_for('static',filename='css/style.css') }}">
</head>
<body class="container">
<div class="col-md-7 offset-md-2">
<a href="/"><img class="rounded" width="100px" src="{{ url_for('static', filename='images/little-printer.png') }}" alt="LittlePrynter icon"></a><h1 class="card-title font-weight-bold">Little Prynter</h1>
<hr>
<div class="alert alert-dark" role="alert">LittlePrynter is under heavy developpement, you may encounter bugs ! If so, try again. Thanks !</div>
<br>
{% with messages = get_flashed_messages(category_filter=('error')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-danger" role="alert">⚠️ {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
{% extends 'base.html' %}
{% with messages = get_flashed_messages(category_filter=('info')) %}
{% if messages %}
{% for message in messages %}
<div class="alert alert-info" role="alert"> {{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
{% block content %}
<!-- <br>
<h3>Imprimer une image aléatoire</h3>
<a class="btn btn-primary btn-lg" href="/api/print/image"> Imprimer</a>
<hr>
<br> -->
<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>
<input class="form-control" type="text" name="signature" placeholder="Signature or pseudo" 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>
</div>
@@ -53,19 +19,11 @@
<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" 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">
</form>
</div>
<!-- <div id="pbar" style="display:none">
<img src="{{ url_for('static',filename='load.gif') }}" alt="loading wheel">
</div> -->
</div>
<hr>
<footer>Little Prynter is built by <a href="https://n07070.xyz/about-me/">n07070</a> because it's fun :) | <a href="https://git.n07070.xyz/n07070/littleprynter/src/branch/epson-tm-t20iii">Source code - AGPLv3</a></footer>
</div>
</body>
</html>
{% endblock %}

111
src/templates/webcam.html Normal file
View File

@@ -0,0 +1,111 @@
{% extends 'base.html' %}
{% block content %}
<noscript class="d-block">
<div class="alert alert-warning " role="alert">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-bug-fill" viewBox="0 0 16 16">
<path d="M4.978.855a.5.5 0 1 0-.956.29l.41 1.352A4.985 4.985 0 0 0 3 6h10a4.985 4.985 0 0 0-1.432-3.503l.41-1.352a.5.5 0 1 0-.956-.29l-.291.956A4.978 4.978 0 0 0 8 1a4.979 4.979 0 0 0-2.731.811l-.29-.956z"/>
<path d="M13 6v1H8.5v8.975A5 5 0 0 0 13 11h.5a.5.5 0 0 1 .5.5v.5a.5.5 0 1 0 1 0v-.5a1.5 1.5 0 0 0-1.5-1.5H13V9h1.5a.5.5 0 0 0 0-1H13V7h.5A1.5 1.5 0 0 0 15 5.5V5a.5.5 0 0 0-1 0v.5a.5.5 0 0 1-.5.5H13zm-5.5 9.975V7H3V6h-.5a.5.5 0 0 1-.5-.5V5a.5.5 0 0 0-1 0v.5A1.5 1.5 0 0 0 2.5 7H3v1H1.5a.5.5 0 0 0 0 1H3v1h-.5A1.5 1.5 0 0 0 1 11.5v.5a.5.5 0 1 0 1 0v-.5a.5.5 0 0 1 .5-.5H3a5 5 0 0 0 4.5 4.975z"/>
</svg>
This page will need Javascript and your authorization to use the webcam to work. It is not possible because Javascript seems to be deactived on this page.
</div>
</noscript>
<div class="card">
<h3 class="card-header">Photomaton</h3>
<div class="card-body row">
<canvas id="canvas"></canvas>
<video id="video" class="">Video stream not available.</video>
<div class="container-sm">
<div class="row">
<button class="col-sm col-lg-3 offset-lg-2 btn btn-primary justify-content-center" name="print_picture" id="print_button" data-bs-toggle="tooltip" data-bs-placement="top" title="Snap & print a picture" disabled="">
<svg xmlns="http://www.w3.org/2000/svg" width="54" height="54" fill="currentColor" class="bi bi-camera" viewBox="0 0 16 16">
<path d="M15 12a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1V6a1 1 0 0 1 1-1h1.172a3 3 0 0 0 2.12-.879l.83-.828A1 1 0 0 1 6.827 3h2.344a1 1 0 0 1 .707.293l.828.828A3 3 0 0 0 12.828 5H14a1 1 0 0 1 1 1v6zM2 4a2 2 0 0 0-2 2v6a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V6a2 2 0 0 0-2-2h-1.172a2 2 0 0 1-1.414-.586l-.828-.828A2 2 0 0 0 9.172 2H6.828a2 2 0 0 0-1.414.586l-.828.828A2 2 0 0 1 3.172 4H2z"/>
<path d="M8 11a2.5 2.5 0 1 1 0-5 2.5 2.5 0 0 1 0 5zm0 1a3.5 3.5 0 1 0 0-7 3.5 3.5 0 0 0 0 7zM3 6.5a.5.5 0 1 1-1 0 .5.5 0 0 1 1 0z"/>
</svg>
</button>
<button class="col-sm col-lg-3 offset-lg-2 btn btn-secondary justify-content-center" name="flip" id="flip" data-bs-toggle="tooltip" data-bs-placement="top" title="Change camera" disabled="">
<svg xmlns="http://www.w3.org/2000/svg" width="54" height="54" fill="currentColor" class="bi bi-arrow-repeat" viewBox="0 0 16 16">
<path d="M11.534 7h3.932a.25.25 0 0 1 .192.41l-1.966 2.36a.25.25 0 0 1-.384 0l-1.966-2.36a.25.25 0 0 1 .192-.41zm-11 2h3.932a.25.25 0 0 0 .192-.41L2.692 6.23a.25.25 0 0 0-.384 0L.342 8.59A.25.25 0 0 0 .534 9z"/>
<path fill-rule="evenodd" d="M8 3c-1.552 0-2.94.707-3.857 1.818a.5.5 0 1 1-.771-.636A6.002 6.002 0 0 1 13.917 7H12.9A5.002 5.002 0 0 0 8 3zM3.1 9a5.002 5.002 0 0 0 8.757 2.182.5.5 0 1 1 .771.636A6.002 6.002 0 0 1 2.083 9H3.1z"/>
</svg>
</button>
</div>
<hr>
<div class="image_dither" id="image_dither">
<picture>
<img id="photo" class="justify-content-center">
</picture>
</div>
<p>
This is a as-close-as-possible representation of what is printed on the thermal printer.
</p>
</div>
</div>
</div>
<div id="countdown">
<div id="countdown-number"></div>
</div>
<style media="screen">
canvas {
display: none;
}
/* video {
display: none;
} */
.image_dither {
/* width: 300px;
height: 400px; */
image-rendering: smooth;
filter: saturate(0) contrast(250);
}
picture {
image-rendering: smooth;
}
.image_dither > picture::after {
content: '';
width: 100%;
height: 100%;
pointer-events: none;
position: fixed;
display: block;
z-index: 2;
top: 0px;
left: 0px;
background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAAECAYAAACp8Z5+AAAAOklEQVR4nC3KQQFAQAAAwd0EIohANA0uiiiugQgiiLA+5j0AVBewVa/VUGd1qBNgrR5gqW6r8x+7Oj8/xCBur9LU/wAAAABJRU5ErkJggg==');
background-repeat: repeat;
}
#photo {
background: linear-gradient(90deg, #00C9FF 0%, #92FE9D 100%);
padding: 0;
max-width: 100%;
vertical-align: middle;
image-rendering: pixelated;
}
</style>
<script src="https://cdn.socket.io/4.0.0/socket.io.min.js"></script>
<script type="text/javascript" src="{{ url_for('static',filename='js/webcam.js') }}"></script>
<br>
{% endblock %}

View File

@@ -1,39 +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']
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('/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("/logout")
def logout():
session['logged_in'] = False
flash('Tu est déconnecté', 'info')
return redirect(url_for('login'))
# 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"))

View File

@@ -1,68 +1,122 @@
from flask import Flask, request
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."""
def __init__(self, app, printer ):
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, 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))
if not os.getenv('LIPY_DEBUG'):
time.sleep(1)
return self.printer.print_sms(texte, sign)
def print_image(self, image, sign: str) -> bool:
self.app.logger.debug("Uploading file")
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)
return True
else:
return False
# 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)
raise Exception
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
else:
flash("Could not upload file.",'error')
return False
def print_image(self, image, sign: str) -> bool:
"""
Get an image and a signature, prints the image and cuts after that.
"""
try:
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
def login(username: str,password: str) -> bool:
pass
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,
)
)
def logout(username: str, password: str) -> bool:
pass
cut = self.print_queue.enqueue(CutTask())
except Exception as 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)
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 ?")
return '.' in filename and filename.rsplit('.', 1)[1].lower() in self.app.config['ALLOWED_EXTENSIONS']
"""
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()
in self.app.config["ALLOWED_EXTENSIONS"]
)
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):
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))
self.app.logger.debug("File saved")
except Exception as e:
self.app.logger.error("Could not save file")
flash(e,'error')
return False
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)))
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.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),
}