From 4fa8a774f26cee22a2127c2e26f1c4d44bbf5629 Mon Sep 17 00:00:00 2001 From: Martin Christoph Frank Date: Sun, 9 Apr 2023 13:16:40 +0200 Subject: [PATCH 1/3] replaced magic numbers with the RequestCodeEnum --- niimprint/printerclient.py | 41 ++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/niimprint/printerclient.py b/niimprint/printerclient.py index 9c7a918..c4bbf03 100644 --- a/niimprint/printerclient.py +++ b/niimprint/printerclient.py @@ -16,6 +16,21 @@ class InfoEnum(enum.IntEnum): DEVICESERIAL = 11 HARDVERSION = 12 +class RequestCodeEnum(enum.IntEnum): + GET_INFO = 64 + GET_RFID = 26 + HEARTBEAT = 220 + SET_LABEL_TYPE = 35 + SET_LABEL_DENSITY = 33 + START_PRINT = 1 + END_PRINT = 243 + START_PAGE_PRINT = 3 + END_PAGE_PRINT = 227 + ALLOW_PRINT_CLEAR = 32 + SET_DIMENSION = 19 + SET_QUANTITY = 21 + GET_PRINT_STATUS = 163 + _packet_to_int = lambda x: int.from_bytes(x.data, 'big') # TODO REMOVE MAGIC NUMBER @@ -58,7 +73,7 @@ class PrinterClient: return resp def get_info(self, key): - if packet := self._transceive(64, bytes((key,)), 64+key): + if packet := self._transceive(RequestCodeEnum.GET_INFO, bytes((key,)), RequestCodeEnum.GET_INFO + key): match key: case InfoEnum.DEVICESERIAL: return packet.data.hex() @@ -72,7 +87,7 @@ class PrinterClient: return None def get_rfid(self): - packet = self._transceive(26, b'\x01', 27) + packet = self._transceive(RequestCodeEnum.GET_RFID, b'\x01', RequestCodeEnum.GET_RFID+1) data = packet.data if data[0] == 0: @@ -101,7 +116,7 @@ class PrinterClient: } def heartbeat(self): - packet = self._transceive(220, b'\x01', 221) + packet = self._transceive(RequestCodeEnum.HEARTBEAT, b'\x01', RequestCodeEnum.HEARTBEAT+1) closingstate = None powerlevel = None paperstate = None @@ -137,43 +152,43 @@ class PrinterClient: def set_label_type(self, n): assert 1 <= n <= 3 - packet = self._transceive(35, bytes((n,)), 51) + packet = self._transceive(RequestCodeEnum.SET_LABEL_TYPE, bytes((n,)), RequestCodeEnum.SET_LABEL_TYPE + 16) return bool(packet.data[0]) def set_label_density(self, n): assert 1 <= n <= 3 - packet = self._transceive(33, bytes((n,)), 49) + packet = self._transceive(RequestCodeEnum.SET_LABEL_DENSITY, bytes((n,)), RequestCodeEnum.SET_LABEL_DENSITY + 16) return bool(packet.data[0]) def start_print(self): - packet = self._transceive(1, b'\x01', 2) + packet = self._transceive(RequestCodeEnum.START_PRINT, b'\x01', RequestCodeEnum.START_PRINT + 1) return bool(packet.data[0]) def end_print(self): - packet = self._transceive(243, b'\x01', 244) + packet = self._transceive(RequestCodeEnum.END_PRINT, b'\x01', RequestCodeEnum.END_PRINT + 1) return bool(packet.data[0]) def start_page_print(self): - packet = self._transceive(3, b'\x01', 4) + packet = self._transceive(RequestCodeEnum.START_PAGE_PRINT, b'\x01', RequestCodeEnum.START_PAGE_PRINT + 1) return bool(packet.data[0]) def end_page_print(self): - packet = self._transceive(227, b'\x01', 228) + packet = self._transceive(RequestCodeEnum.END_PAGE_PRINT, b'\x01', RequestCodeEnum.END_PAGE_PRINT + 1) return bool(packet.data[0]) def allow_print_clear(self): - packet = self._transceive(32, b'\x01', 48) + packet = self._transceive(RequestCodeEnum.ALLOW_PRINT_CLEAR, b'\x01', RequestCodeEnum.ALLOW_PRINT_CLEAR + 16) return bool(packet.data[0]) def set_dimension(self, w, h): - packet = self._transceive(19, struct.pack('>HH', w, h), 20) + packet = self._transceive(RequestCodeEnum.SET_DIMENSION, struct.pack('>HH', w, h), RequestCodeEnum.SET_DIMENSION + 1) return bool(packet.data[0]) def set_quantity(self, n): - packet = self._transceive(21, struct.pack('>H', n), 22) + packet = self._transceive(RequestCodeEnum.SET_QUANTITY, struct.pack('>H', n), RequestCodeEnum.SET_QUANTITY + 1) return bool(packet.data[0]) def get_print_status(self): - packet = self._transceive(163, b'\x01', 179) + packet = self._transceive(RequestCodeEnum.GET_PRINT_STATUS, b'\x01', RequestCodeEnum.GET_PRINT_STATUS + 16) page, progress1, progress2 = struct.unpack('>HBB', packet.data) return {'page': page, 'progress1': progress1, 'progress2': progress2} From 908e1bbfbf2193fbacaf8b616226f7c8780a819f Mon Sep 17 00:00:00 2001 From: Martin Christoph Frank Date: Sun, 9 Apr 2023 13:20:03 +0200 Subject: [PATCH 2/3] changed transceive response code to an offset relative to the reqcode --- niimprint/printerclient.py | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/niimprint/printerclient.py b/niimprint/printerclient.py index c4bbf03..29134b3 100644 --- a/niimprint/printerclient.py +++ b/niimprint/printerclient.py @@ -56,7 +56,8 @@ class PrinterClient: # print('send:',packet) self._sock.send(packet.to_bytes()) - def _transceive(self, reqcode, data, respcode): + def _transceive(self, reqcode, data, respoffset): + respcode = respoffset + reqcode self._send(niimbotpacket.NiimbotPacket(reqcode, data)) resp = None for _ in range(6): @@ -73,7 +74,7 @@ class PrinterClient: return resp def get_info(self, key): - if packet := self._transceive(RequestCodeEnum.GET_INFO, bytes((key,)), RequestCodeEnum.GET_INFO + key): + if packet := self._transceive(RequestCodeEnum.GET_INFO, bytes((key,)), key): match key: case InfoEnum.DEVICESERIAL: return packet.data.hex() @@ -87,7 +88,7 @@ class PrinterClient: return None def get_rfid(self): - packet = self._transceive(RequestCodeEnum.GET_RFID, b'\x01', RequestCodeEnum.GET_RFID+1) + packet = self._transceive(RequestCodeEnum.GET_RFID, b'\x01', 1) data = packet.data if data[0] == 0: @@ -116,7 +117,7 @@ class PrinterClient: } def heartbeat(self): - packet = self._transceive(RequestCodeEnum.HEARTBEAT, b'\x01', RequestCodeEnum.HEARTBEAT+1) + packet = self._transceive(RequestCodeEnum.HEARTBEAT, b'\x01', 1) closingstate = None powerlevel = None paperstate = None @@ -152,43 +153,43 @@ class PrinterClient: def set_label_type(self, n): assert 1 <= n <= 3 - packet = self._transceive(RequestCodeEnum.SET_LABEL_TYPE, bytes((n,)), RequestCodeEnum.SET_LABEL_TYPE + 16) + packet = self._transceive(RequestCodeEnum.SET_LABEL_TYPE, bytes((n,)), 16) return bool(packet.data[0]) def set_label_density(self, n): assert 1 <= n <= 3 - packet = self._transceive(RequestCodeEnum.SET_LABEL_DENSITY, bytes((n,)), RequestCodeEnum.SET_LABEL_DENSITY + 16) + packet = self._transceive(RequestCodeEnum.SET_LABEL_DENSITY, bytes((n,)), 16) return bool(packet.data[0]) def start_print(self): - packet = self._transceive(RequestCodeEnum.START_PRINT, b'\x01', RequestCodeEnum.START_PRINT + 1) + packet = self._transceive(RequestCodeEnum.START_PRINT, b'\x01', 1) return bool(packet.data[0]) def end_print(self): - packet = self._transceive(RequestCodeEnum.END_PRINT, b'\x01', RequestCodeEnum.END_PRINT + 1) + packet = self._transceive(RequestCodeEnum.END_PRINT, b'\x01', 1) return bool(packet.data[0]) def start_page_print(self): - packet = self._transceive(RequestCodeEnum.START_PAGE_PRINT, b'\x01', RequestCodeEnum.START_PAGE_PRINT + 1) + packet = self._transceive(RequestCodeEnum.START_PAGE_PRINT, b'\x01', 1) return bool(packet.data[0]) def end_page_print(self): - packet = self._transceive(RequestCodeEnum.END_PAGE_PRINT, b'\x01', RequestCodeEnum.END_PAGE_PRINT + 1) + packet = self._transceive(RequestCodeEnum.END_PAGE_PRINT, b'\x01', 1) return bool(packet.data[0]) def allow_print_clear(self): - packet = self._transceive(RequestCodeEnum.ALLOW_PRINT_CLEAR, b'\x01', RequestCodeEnum.ALLOW_PRINT_CLEAR + 16) + packet = self._transceive(RequestCodeEnum.ALLOW_PRINT_CLEAR, b'\x01', 16) return bool(packet.data[0]) def set_dimension(self, w, h): - packet = self._transceive(RequestCodeEnum.SET_DIMENSION, struct.pack('>HH', w, h), RequestCodeEnum.SET_DIMENSION + 1) + packet = self._transceive(RequestCodeEnum.SET_DIMENSION, struct.pack('>HH', w, h), 1) return bool(packet.data[0]) def set_quantity(self, n): - packet = self._transceive(RequestCodeEnum.SET_QUANTITY, struct.pack('>H', n), RequestCodeEnum.SET_QUANTITY + 1) + packet = self._transceive(RequestCodeEnum.SET_QUANTITY, struct.pack('>H', n), 1) return bool(packet.data[0]) def get_print_status(self): - packet = self._transceive(RequestCodeEnum.GET_PRINT_STATUS, b'\x01', RequestCodeEnum.GET_PRINT_STATUS + 16) + packet = self._transceive(RequestCodeEnum.GET_PRINT_STATUS, b'\x01', 16) page, progress1, progress2 = struct.unpack('>HBB', packet.data) return {'page': page, 'progress1': progress1, 'progress2': progress2} From 7962ee4e479bb05b7778c716652e95e0577b878e Mon Sep 17 00:00:00 2001 From: Martin Christoph Frank Date: Sun, 9 Apr 2023 13:21:57 +0200 Subject: [PATCH 3/3] set default respoffset to 1 --- niimprint/printerclient.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/niimprint/printerclient.py b/niimprint/printerclient.py index 29134b3..35189ee 100644 --- a/niimprint/printerclient.py +++ b/niimprint/printerclient.py @@ -56,7 +56,7 @@ class PrinterClient: # print('send:',packet) self._sock.send(packet.to_bytes()) - def _transceive(self, reqcode, data, respoffset): + def _transceive(self, reqcode, data, respoffset=1): respcode = respoffset + reqcode self._send(niimbotpacket.NiimbotPacket(reqcode, data)) resp = None @@ -88,7 +88,7 @@ class PrinterClient: return None def get_rfid(self): - packet = self._transceive(RequestCodeEnum.GET_RFID, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.GET_RFID, b'\x01') data = packet.data if data[0] == 0: @@ -117,7 +117,7 @@ class PrinterClient: } def heartbeat(self): - packet = self._transceive(RequestCodeEnum.HEARTBEAT, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.HEARTBEAT, b'\x01') closingstate = None powerlevel = None paperstate = None @@ -162,19 +162,19 @@ class PrinterClient: return bool(packet.data[0]) def start_print(self): - packet = self._transceive(RequestCodeEnum.START_PRINT, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.START_PRINT, b'\x01') return bool(packet.data[0]) def end_print(self): - packet = self._transceive(RequestCodeEnum.END_PRINT, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.END_PRINT, b'\x01') return bool(packet.data[0]) def start_page_print(self): - packet = self._transceive(RequestCodeEnum.START_PAGE_PRINT, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.START_PAGE_PRINT, b'\x01') return bool(packet.data[0]) def end_page_print(self): - packet = self._transceive(RequestCodeEnum.END_PAGE_PRINT, b'\x01', 1) + packet = self._transceive(RequestCodeEnum.END_PAGE_PRINT, b'\x01') return bool(packet.data[0]) def allow_print_clear(self): @@ -182,11 +182,11 @@ class PrinterClient: return bool(packet.data[0]) def set_dimension(self, w, h): - packet = self._transceive(RequestCodeEnum.SET_DIMENSION, struct.pack('>HH', w, h), 1) + packet = self._transceive(RequestCodeEnum.SET_DIMENSION, struct.pack('>HH', w, h)) return bool(packet.data[0]) def set_quantity(self, n): - packet = self._transceive(RequestCodeEnum.SET_QUANTITY, struct.pack('>H', n), 1) + packet = self._transceive(RequestCodeEnum.SET_QUANTITY, struct.pack('>H', n)) return bool(packet.data[0]) def get_print_status(self):