1
0
mirror of https://github.com/python-escpos/python-escpos synced 2025-10-23 09:30:00 +00:00

modernize and cleanup documentation (#542)

* disable system packages on rtd

* install pycups on rtd

* enable cups binding in documentation

* document CupsPrinter

* fix formatting

* revise methods and installation

* revise user/printers

* revise raspi section

* further revise
This commit is contained in:
Patrick Kanzler
2023-08-10 01:38:47 +02:00
committed by GitHub
parent 4c2dcdfac6
commit 2b62c8e28d
18 changed files with 174 additions and 103 deletions

View File

@@ -1,41 +1,26 @@
Raspberry Pi
============
:Last Reviewed: 2017-01-05
:Last Reviewed: 2023-08-10
This instructions were tested on Raspbian Jessie.
.. warning:: You should **never** directly connect an printer with RS232-interface (serial port) directly to
a Raspberry PI or similar interface (e.g. those simple USB-sticks without encasing). Those interfaces are
based on 5V- or 3,3V-logic (the latter in the case of Raspberry PI). Classical RS232 uses 12V-logic and would
**thus destroy your interface**. Connect both systems with an appropriate *level shifter*.
Dependencies
------------
First, install the packages available on Raspbian.
::
sudo apt-get install python3 python3-setuptools python3-pip libjpeg8-dev
.. warning:: You should **never** directly connect an printer with RS232-interface
(serial port) directly to a Raspberry PI or similar interface
(e.g. those simple USB-sticks without encasing).
Those interfaces are based on 5V- or 3,3V-logic
(the latter in the case of Raspberry PI).
Classical RS232 uses 12V-logic and would **thus destroy your interface**.
Connect both systems with an appropriate *level shifter*.
Installation
------------
You can install by using pip3.
::
sudo pip3 install --upgrade pip
sudo pip3 install python-escpos
The installation should be performed as described in :ref:`user_installation`.
Run
---
You need sudo and python3 to run your program.
You can run this software as on any other Linux system.
::
sudo python3 your-program.py
Now you can attach your printer and and test it with the example code in the project's set of examples.
You can find that in the `project-repository <https://github.com/python-escpos/python-escpos>`__.
Attach your printer and test it with the example code in the project's set of examples.
You can find that in the
`project-repository <https://github.com/python-escpos/python-escpos>`__.
For more details on this check the :doc:`installation-manual <installation>`.