Revide README. Use EpsonLpr in UI. EUPL 1.2 license

.jekyll-gh-pages/_config.yml

@@ -77,7 +77,7 @@ liquid:
 back_to_top: true
 back_to_top_text: "Back to top"
 
-footer_content: 'Copyright &copy; 2023-2024 Ircama. Distributed by an <a href="https://raw.githubusercontent.com/Ircama/epson_print_conf/refs/heads/main/LICENSE">MIT license.</a>'
+footer_content: 'Copyright &copy; 2023-2025 Ircama. Distributed by the <a href="https://raw.githubusercontent.com/Ircama/epson_print_conf/refs/heads/main/LICENSE">EUPL-1.2 License.</a>'
 
 # Footer last edited timestamp
 last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter

LICENSE

@@ -1,21 +1,284 @@
-MIT License
+Copyright (c) 2024-2025 Ircama, EUPL-1.2
 
-Copyright (c) 2023 Ircama
+Corresponding SPDX licence: European Union Public License 1.2
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Licence ID: EUPL-1.2
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
+See also:
-copies or substantial portions of the Software.
+https://opensource.org/licenses/EUPL-1.2
+https://joinup.ec.europa.eu/software/page/eupl/licence-eupl
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+European Union Public Licence
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+V. 1.2
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+EUPL © the European Union 2007, 2016
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as
-SOFTWARE.
+defined below) which is provided under the terms of this Licence. Any use of
+the Work, other than as authorised under this Licence is prohibited (to the
+extent such use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work: “Licensed under the EUPL”, or has expressed by
+any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+— ‘The Licence’: this Licence.
+— ‘The Original Work’: the work or software distributed or communicated by the
+  ‘Licensor under this Licence, available as Source Code and also as
+  ‘Executable Code as the case may be.
+— ‘Derivative Works’: the works or software that could be created by the
+  ‘Licensee, based upon the Original Work or modifications thereof. This
+  ‘Licence does not define the extent of modification or dependence on the
+  ‘Original Work required in order to classify a work as a Derivative Work;
+  ‘this extent is determined by copyright law applicable in the country
+  ‘mentioned in Article 15.
+— ‘The Work’: the Original Work or its Derivative Works.
+— ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+— ‘The Executable Code’: any code which has generally been compiled and which
+  is meant to be interpreted by a computer as a program.
+— ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+— ‘Contributor(s)’: any natural or legal person who modifies the Work under
+  the Licence, or otherwise contributes to the creation of a Derivative Work.
+— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright
+vested in the Original Work:
+
+— use the Work in any circumstance and for all usage,
+— reproduce the Work,
+— modify the Work, and make Derivative Works based upon the Work,
+— communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case
+  may be, the Work,
+— distribute the Work or copies thereof,
+— lend and rent the Work or copies thereof,
+— sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make
+effective the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights
+to any patents held by the Licensor, to the extent necessary to make use of
+the rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates,
+in a notice following the copyright notice attached to the Work, a repository
+where the Source Code is easily and freely accessible for as long as the
+Licensor continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits
+from any exception or limitation to the exclusive rights of the rights owners
+in the Work, of the exhaustion of those rights or of other applicable
+limitations thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and
+a copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of
+the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions
+on the Work or Derivative Work that alter or restrict the terms of the
+Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed
+under a Compatible Licence, this Distribution or Communication can be done
+under the terms of this Compatible Licence. For the sake of this clause,
+‘Compatible Licence’ refers to the licences listed in the appendix attached to
+this Licence. Should the Licensee's obligations under the Compatible Licence
+conflict with his/her obligations under this Licence, the obligations of the
+Compatible Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the
+Work, the Licensee will provide a machine-readable copy of the Source Code or
+indicate a repository where this Source will be easily and freely available
+for as long as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade
+names, trademarks, service marks, or names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she
+brings to the Work are owned by him/her or licensed to him/her and that he/she
+has the power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’
+basis and without warranties of any kind concerning the Work, including
+without limitation merchantability, fitness for a particular purpose, absence
+of defects or errors, accuracy, non-infringement of intellectual property
+rights other than copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a
+condition for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the
+use of the Work, including without limitation, damages for loss of goodwill,
+work stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such
+damage. However, the Licensor will be liable under statutory product liability
+laws as far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional
+agreement, defining obligations or services consistent with this Licence.
+However, if accepting obligations, You may act only on your own behalf and on
+your sole responsibility, not on behalf of the original Licensor or any other
+Contributor, and only if You agree to indemnify, defend, and hold each
+Contributor harmless for any liability incurred by, or claims asserted against
+such Contributor by the fact You have accepted any warranty or additional
+liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I
+agree’ placed under the bottom of a window displaying the text of this Licence
+or by affirming consent in any other similar way, in accordance with the rules
+of applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this
+Licence, such as the use of the Work, the creation by You of a Derivative Work
+or the Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of
+electronic communication by You (for example, by offering to download the Work
+from a remote location) the distribution channel or media (for example, a
+website) must at least provide to the public the information requested by the
+applicable law regarding the Licensor, the Licence and the way it may be
+accessible, concluded, stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence. Such a termination
+will not terminate the licences of any person who has received the Work from
+the Licensee under the Licence, provided such persons remain in full
+compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions
+of this Licence or updated versions of the Appendix, so far this is required
+and reasonable, without reducing the scope of the rights granted by the
+Licence. New versions of the Licence will be published with a unique version
+number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+— any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty
+  on the Functioning of the European Union,
+— any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive
+  jurisdiction of the competent court where the Licensor resides or conducts
+  its primary business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+— this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+— this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+— GNU General Public License (GPL) v. 2, v. 3
+— GNU Affero General Public License (AGPL) v. 3
+— Open Software License (OSL) v. 2.1, v. 3.0
+— Eclipse Public License (EPL) v. 1.0
+— CeCILL v. 2.0, v. 2.1
+— Mozilla Public Licence (MPL) v. 2
+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+— European Union Public Licence (EUPL) v. 1.1, v. 1.2
+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or
+  Strong Reciprocity (LiLiQ-R+)
+
+— The European Commission may update this Appendix to later versions of the
+  above licences without producing a new version of the EUPL, as long as they
+  provide the rights granted in Article 2 of this Licence and protect the
+  covered Source Code from exclusive appropriation.
+— All other changes or additions to this Appendix require the production of a
+  new EUPL version.

README.md

@@ -25,7 +25,7 @@ The software also includes a configurable printer dictionary, which can be easil
 
     - Clean Nozzles.
     
-      Performs a standard cleaning cycle on the selected nozzle group.
+      Standard cleaning cycle on the selected nozzle group, allowing to select black/color nozzles.
       
     - Power Clean of the nozzles.
 
@@ -538,7 +538,7 @@ pprint.pprint(printer.status_parser(printer.fetch_snmp_values("1.3.6.1.4.1.1248.
   – Carries the actual print-job content: raster image streams, font/download data, macros, etc.
   - Allow "Remote Mode" commands, entered and terminated via a special sequence (`ESC (R BC=8 00 R E M O T E 1`, `ESC 00 00 00`); [remote mode commands](https://gimp-print.sourceforge.io/reference-html/x952.html) are partially documented and have a similar structure as EPSON-CTRL (2 letters + length + payload), but the letters are uppercase and cannot be mapped to SNMP.
 
-EPSON-CTRL can be transported over D4, or encapsulated in SNMP OIDs. Some EPSON-CTRL instructions implement a subset of Epson’s Remote Mode protocol, while others are proprietary.
+EPSON-CTRL can be transported over D4, or encapsulated in SNMP OIDs. Some EPSON-CTRL instructions implement a subset of Epson’s Remote Mode protocol, while others are proprietary. Such commands are named "Packet Commands" in the Epson printer Service Manuals and specifically the "EPSON LX-300+II and LX-1170II Service manuals" (old impact dot matrix printers) document "di", "st" and also "||" in the "Packet commands" table.
 
 END4 is a proprietary protocol to transport EPSON-CTRL commands [over the standard print channel](https://codeberg.org/atufi/reinkpy/issues/12#issuecomment-1660026), without using the EPSON-CTRL channel.
 
@@ -564,7 +564,7 @@ The following is the list of EPSON-CTRL commands supported by the XP-205.
 
 Two-bytes|Description | Notes | Parameters
 :--:| ---------------------------------------------- | ----------------| -------------
-\|\| | EEPROM access | Implemented in this program, not supported by new printer firmwares | (A, B); see examples below
+\|\| | EEPROM access | Implemented in this program, the SNMP OID version is not supported by new printer firmwares | (A, B); see examples below
 cd | | | (0)
 cs |  | | (0 or 1)
 cx | | |
@@ -588,20 +588,14 @@ ti | Set printer time | ("ti" 08H 00H 00H YYYY MM DD hh mm ss) |
 vi | Version Information | Implemented in this program | (0)
 xi | | | (1)
 
-escutil.c also mentions ["ri\2\0\0\0"](https://github.com/echiu64/gutenprint/blob/master/src/escputil/escputil.c#L1944) (Attempt to reset ink).
+escutil.c also mentions [`ri\2\0\0\0`](https://github.com/echiu64/gutenprint/blob/master/src/escputil/escputil.c#L1944) (Attempt to reset ink) in some printer firmwares.
+
+[Other font](https://codeberg.org/KalleMP/reinkpy/src/branch/main/reinkpy/epson/core.py#L22) also mentions `pc:\x01:NA` in some printer firmwares.
 
 ### Examples for EEPROM access
 
 #### Read EEPROM
 
-- 124.124: "||" = Read EEPROM (EPSON-CTRL)
-- 7.0: Two-byte payload length = 7 bytes
-- two bytes for the read key
-- 65: 'A' = read
-- 190: [Take the bitwise NOT of the ASCII value of 'A' = read, then mask to the lowest 8 bits](https://github.com/lion-simba/reink/blob/master/reink.c#L1414). The result is 190.
-- 160: [Shift the ASCII value of 'A' (read) right by 1 and mask to 7 bits, then OR it with the highest bit of the value shifted left by 7](https://github.com/lion-simba/reink/blob/master/reink.c#L1415). The result is 160.
-- two bytes for the EEPROM address
-
 ```
 124.124.7.0. [7C 7C 07 00]
 <READ KEY (two bytes)>
@@ -609,7 +603,23 @@ escutil.c also mentions ["ri\2\0\0\0"](https://github.com/echiu64/gutenprint/blo
 <LSB EEPROM ADDRESS (one byte)>.<MSB EEPROM ADDRESS (one byte)>
 ```
 
-Example: `1.3.6.1.4.1.1248.1.2.2.44.1.1.2.1.124.124.7.0.73.8.65.190.160.48.0`
+- 124.124: "||" = Read EEPROM (EPSON-CTRL)
+- 7.0: Two-byte payload length = 7 bytes (7 bytes payload length means two-byte EEPROM address, used in recent printers; old printers supported 6 bytes payload length for a single byte EEPROM address).
+- two bytes for the read key (named "R code" in the "EPSON LX-300+II and LX-1170II Service manuals")
+- 65: 'A' = read (41H)
+- 190: [Take the bitwise NOT of the ASCII value of 'A' = read, then mask to the lowest 8 bits](https://github.com/lion-simba/reink/blob/master/reink.c#L1414). The result is 190 (BEH).
+- 160: [Shift the ASCII value of 'A' (read) right by 1 and mask to 7 bits, then OR it with the highest bit of the value shifted left by 7](https://github.com/lion-simba/reink/blob/master/reink.c#L1415). The result is 160 (A0H).
+- two bytes for the EEPROM address (one byte if the payload length is 6 bytes)
+
+From the Epson Service manual of LX-300+II and LX-1170II (single byte form):
+
+```
+“||” 06H 00H r1 r2 41H BEH A0H d1
+r1, r2 means R code. (e.g. r1=A8, r2=5Ah)
+d1 : EEPROM address (00h - FFh)
+```
+
+SNMP OID example: `1.3.6.1.4.1.1248.1.2.2.44.1.1.2.1.124.124.7.0.73.8.65.190.160.48.0`
 
 #### Write EEPROM
 
@@ -632,7 +642,7 @@ Example: `1.3.6.1.4.1.1248.1.2.2.44.1.1.2.1.124.124.7.0.73.8.65.190.160.48.0`
 <WRITE KEY (eight bytes)>
 ```
 
-Example: `7C 7C 10 00 49 08 42 BD 21 30 00 1A 42 73 62 6F 75 6A 67 70`
+SNMP OID example: `7C 7C 10 00 49 08 42 BD 21 30 00 1A 42 73 62 6F 75 6A 67 70`
 
 #### Returned data
 
@@ -1057,6 +1067,10 @@ escputil.c: https://github.com/echiu64/gutenprint/blob/master/src/escputil/escpu
 - PrintHelp: <https://printhelp.info/> (Use at your risk)
 
 ### Other resources
-
+- <https://github.com/lion-simba/reink/files/14553492/devices.zip>
 - <https://codeberg.org/attachments/147f41a3-a6ea-45f6-8c2a-25bac4495a1d>
 - <https://codeberg.org/atufi/reinkpy/src/branch/main/reinkpy/epson.toml>
+
+## License
+
+EUPL-1.2 License - See [LICENSE](LICENSE) for details.

epson_print_conf.py

@@ -53,9 +53,9 @@ class EpsonLpr:
         # Define Epson sequences
         self.LF = b'\x0a'
         self.FF = b'\x0c'  # flush buffer
+        self.UNIVERSAL_EXIT = b'\x00\x00\x00\x1b\x01'  # required by newer printers
         self.EXIT_PACKET_MODE = (
-            b'\x00\x00\x00\x1b\x01@EJL 1284.4\n@EJL     ' +
+            self.UNIVERSAL_EXIT + b'@EJL 1284.4\n@EJL     ' + self.LF
-            self.LF
         )
         self.INITIALIZE_PRINTER = b'\x1b@'
         self.REMOTE_MODE = b'\x1b' + self.remote_cmd("(R", b'\x00REMOTE1')
@@ -71,6 +71,13 @@ class EpsonLpr:
         self.VERSION_INFORMATION = self.remote_cmd("VI", b'\x00\x00')
         self.LD = self.remote_cmd("LD", b'')
 
+    def __enter__(self) -> "EpsonLpr":
+        self.connect()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        self.disconnect()
+
     def connect(self) -> None:
         """Establish a TCP connection to the printer."""
         self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -99,7 +106,7 @@ class EpsonLpr:
     def remote_cmd(self, cmd, args):
         "Generate a Remote Mode command."
         if len(cmd) != 2:
-            raise ValueError("command should be 2 bytes")
+            raise ValueError("command should be exactly 2 characters")
         return cmd.encode() + struct.pack('<H', len(args)) + args
 
 

ui.py

@@ -12,7 +12,6 @@ import threading
 import ipaddress
 import inspect
 from datetime import datetime
-import socket
 import traceback
 import logging
 import webbrowser
@@ -31,7 +30,7 @@ from tkcalendar import DateEntry  # Ensure you have: pip install tkcalendar
 from tkinter import simpledialog, messagebox, filedialog
 
 import pyperclip
-from epson_print_conf import EpsonPrinter, get_printer_models
+from epson_print_conf import EpsonPrinter, get_printer_models, EpsonLpr
 from parse_devices import generate_config_from_toml, generate_config_from_xml, normalize_config
 from find_printers import PrinterScanner
 from text_console import TextConsole
@@ -3567,10 +3566,6 @@ Web site: https://github.com/Ircama/epson_print_conf
 
     def print_items(self, text):
         """Send items to the printer."""
-        exit_packet_mode = b'\x00\x00\x00\x1b\x01@EJL 1284.4\n@EJL     \n'
-        initialize_printer = b"\x1B\x40"
-        form_feed = b"\f"
-
         ip_address = self.ip_var.get()
         if not self._is_valid_ip(ip_address):
             self.show_status_text_view()
@@ -3580,14 +3575,13 @@ Web site: https://github.com/Ircama/epson_print_conf
             )
             return
         try:
-            with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+            with EpsonLpr(ip_address) as lpr:
-                sock.connect((ip_address, 9100))
+                lpr.send(
-                sock.sendall(
+                    lpr.EXIT_PACKET_MODE
-                    exit_packet_mode
+                    + lpr.INITIALIZE_PRINTER
-                    + initialize_printer
                     + b"Printer configuration\n"
                     + text.encode('utf-8')
-                    + form_feed
+                    + lpr.FF
                 )
         except Exception as e:
             self.show_status_text_view()