Device dependent margins/config

src/labelle/gui/gui.py

@@ -63,7 +63,7 @@ def _init_elements(self) -> None:
         self._device_manager = DeviceManager()
         self._dymo_labeler = DymoLabeler()
         self._settings_toolbar.update_labeler_context(
-            supported_tape_sizes=self._dymo_labeler.SUPPORTED_TAPE_SIZES_MM,
+            supported_tape_sizes=self._dymo_labeler._deviceConfig.supportedTapeSizes,
             installed_tape_size=self._dymo_labeler.tape_size_mm,
             minimum_horizontal_margin_mm=self._dymo_labeler.minimum_horizontal_margin_mm,
         )

src/labelle/gui/q_settings_toolbar.py

@@ -57,7 +57,7 @@ def _init_elements(self) -> None:
 
     def update_labeler_context(
         self,
-        supported_tape_sizes: tuple[int, ...],
+        supported_tape_sizes: list[int],
         installed_tape_size: int,
         minimum_horizontal_margin_mm: float,
     ) -> None:

src/labelle/lib/constants.py

@@ -13,11 +13,12 @@
 # either sysfs is unavailable or unusable by this script for some reason.
 # Please beware that DEV_NODE must be set to None when not used, else you will
 # be bitten by the NameError exception.
-from enum import Enum
+from enum import Enum, IntEnum
 from pathlib import Path
 
 import labelle.resources.fonts
 import labelle.resources.icons
+from labelle.lib.devices.device_config import DeviceConfig
 
 try:
     from pyqrcode import QRCode
@@ -34,19 +35,139 @@
     "WARNING: This device is not confirmed to work with this software. Please "
     "report your experiences in https://github.com/labelle-org/labelle/issues/4"
 )
-SUPPORTED_PRODUCTS = {
-    0x0011: "DYMO LabelMANAGER PC",
-    0x0015: "LabelPoint 350",
-    0x1001: "LabelManager PnP (no mode switch)",
-    0x1002: "LabelManager PnP (mode switch)",
-    0x1003: f"LabelManager 420P (no mode switch) {UNCONFIRMED_MESSAGE}",
-    0x1004: f"LabelManager 420P (mode switch) {UNCONFIRMED_MESSAGE}",
-    0x1005: "LabelManager 280 (no mode switch)",
-    0x1006: "LabelManager 280 (no mode switch)",
-    0x1007: f"LabelManager Wireless PnP (no mode switch) {UNCONFIRMED_MESSAGE}",
-    0x1008: f"LabelManager Wireless PnP (mode switch) {UNCONFIRMED_MESSAGE}",
-    0x1009: f"MobileLabeler {UNCONFIRMED_MESSAGE}",
-}
+
+
+# Supported USB device ID enumeration
+class SUPPORTED_DEVICE_ID(IntEnum):
+    LABELMANAGER_PC = 0x0011
+    LABELPOINT_350 = 0x0015
+    LABELMANAGER_PC_II = 0x001C
+    LABELMANAGER_PNP_NO_MODE_SWITCH = 0x1001
+    LABELMANAGER_PNP_MODE_SWITCH = 0x1002
+    LABELMANAGER_420P_NO_MODE_SWITCH = 0x1003
+    LABELMANAGER_420P_MODE_SWITCH = 0x1004
+    LABELMANAGER_280P_NO_MODE_SWITCH = 0x1005
+    LABELMANAGER_280P_MODE_SWITCH = 0x1006
+    LABELMANAGER_WIRELESS_PNP_NO_MODE_SWITCH = 0x1007
+    LABELMANAGER_WIRELESS_PNP_MODE_SWITCH = 0x1008
+    MOBILE_LABELER = 0x1009
+
+
+# Create supported products list
+SUPPORTED_PRODUCTS = []
+
+# ---- Supported USB Devices configuration ----
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        "DYMO LabelMANAGER PC",
+        [int(SUPPORTED_DEVICE_ID.LABELMANAGER_PC)],
+        # ToDo: Validate config!
+        # Printhead 128 Pixels, distributed over 18mm of active area
+        128,
+        18,
+        [6, 9, 12, 19],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        "LabelPoint 350",
+        [int(SUPPORTED_DEVICE_ID.LABELPOINT_350)],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        "DYMO LabelMANAGER PC II",
+        [int(SUPPORTED_DEVICE_ID.LABELMANAGER_PC_II)],
+        # Printhead 128 Pixels, distributed over 18mm of active area
+        128,
+        18,
+        [6, 9, 12, 19, 24],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        "LabelManager PnP",
+        [
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_PNP_NO_MODE_SWITCH),
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_PNP_MODE_SWITCH),
+        ],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        f"LabelManager 420P {UNCONFIRMED_MESSAGE}",
+        [
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_420P_NO_MODE_SWITCH),
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_420P_MODE_SWITCH),
+        ],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        "LabelManager 280",
+        [
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_280P_MODE_SWITCH),
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_280P_NO_MODE_SWITCH),
+        ],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        f"LabelManager Wireless PnP {UNCONFIRMED_MESSAGE}",
+        [
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_WIRELESS_PNP_NO_MODE_SWITCH),
+            int(SUPPORTED_DEVICE_ID.LABELMANAGER_WIRELESS_PNP_MODE_SWITCH),
+        ],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+SUPPORTED_PRODUCTS.append(
+    DeviceConfig(
+        f"MobileLabeler {UNCONFIRMED_MESSAGE}",
+        [int(SUPPORTED_DEVICE_ID.MOBILE_LABELER)],
+        # ToDo: Validate config!
+        # Printhead 64 Pixels, distributed over 9mm of active area
+        64,
+        9,
+        [6, 9, 12],
+    )
+)
+
+# Simulator configuration
+SIMULATOR_CONFIG = DeviceConfig(
+    "Simulator",
+    [0],
+    # Fake printhead 128 Pixels, distributed over 18mm of active area
+    128,
+    18,
+    [6, 9, 12, 19, 24],
+)
+
+
 DEV_VENDOR = 0x0922
 
 PRINTER_INTERFACE_CLASS = 0x07

src/labelle/lib/devices/device_config.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+import logging
+import math
+
+LOG = logging.getLogger(__name__)
+
+
+class DeviceConfig:
+    """Configuration object for the capabilities of a label printer."""
+
+    name: str
+    """Name of this device"""
+
+    deviceIDs: list[int]
+    """List of USB Device ID's this device can identify as"""
+
+    printHeadSizePixels: int
+    """Size of the print head in pixels (use calibration routine to determine)"""
+
+    printHeadActiveAreaMillimeters: float
+    """Size of the active area of the print head in millimters
+        (use calibration routine to determine)"""
+
+    supportedTapeSizes: list[int]
+    """List of supported tape sizes in mm"""
+
+    # Fixed to 1 mm until proven otherwise ;)
+    TAPE_ALIGNMENT_INACCURACY_MM: float = 1
+    """The inaccuracy of the tape position relative to the printhead"""
+    # Inaccuracy of the tape position is mostly caused by
+    # the tape moving slightly from side to side in the cartridge.
+    # Improper cartrigde placemement is also an factor,
+    # but negligible due to a physical spring in the lid.
+
+    def __init__(
+        self,
+        name: str,
+        deviceIDs: list[int],
+        printHeadSizePixels: int,
+        printHeadActiveAreaMillimeters: int,
+        supportedTapeSizes: list[int],
+    ):
+        """Initialize a Labeler config object."""
+        self.name = name
+        self.deviceIDs = deviceIDs
+        self.printHeadSizePixels = printHeadSizePixels
+        self.printHeadActiveAreaMillimeters = printHeadActiveAreaMillimeters
+        self.supportedTapeSizes = supportedTapeSizes
+
+    def matches_device_id(self, idValue: int) -> bool:
+        """Check if the a device ID matches this config."""
+        if idValue in self.deviceIDs:
+            return True
+        else:
+            return False
+
+    def get_tape_print_size_and_margins_px(
+        self, tapeSizeMM: int
+    ) -> tuple[int, int, int]:
+        """Get print margins for a specific tape size.
+
+        :param tapeSizeMM: Tape size in mm
+        :return: Margins tuple in pixels [ActivePixels,TopMarginPx,BottomMarginPx]
+        """
+        if tapeSizeMM in self.supportedTapeSizes:
+            # Calculate the pixels per mm for this printer
+            # Example: printhead of 128 Pixels, distributed over 18 mm of active area.
+            #   Makes 7.11 pixels/mm
+            printPPmm: float = (
+                self.printHeadSizePixels / self.printHeadActiveAreaMillimeters
+            )
+
+            # Calculate usable tape width (*2 for top and bottom)
+            usableTapeWidth: float = tapeSizeMM - (
+                self.TAPE_ALIGNMENT_INACCURACY_MM * 2
+            )
+
+            # Calculate the numer of active pixels for the tape
+            activeTapePixels: float = 0
+            if usableTapeWidth >= self.printHeadActiveAreaMillimeters:
+                # Tape is larger than active area of printhead. Use all pixels
+                activeTapePixels = self.printHeadSizePixels
+            else:
+                # Calculate the amount of active pixels we are able to use
+                # (taking the placement inaccuracy into account)
+                activeTapePixels = printPPmm * usableTapeWidth
+
+            # Round down to nearest whole number as we can't use half a pixels ;)
+            activeTapePixels = math.floor(activeTapePixels)
+
+            # To calculate the margins we need to know some hardware info
+            # Printer has special "support studs" that
+            # let 19 & 24mm tapes go to the bottom (if supported)
+            # but 12mm based casettes are raised so they are centered to the printhead.
+            # Smaller tapes than 12mm are in 12mm casettes are centered
+            # in the cartridge and in turn also centered to the printhead
+            # Which gives us the advantage that we can
+            # just calculate the top and bottom margin
+
+            # Calculate the top margin
+            topMargin = round(((self.printHeadSizePixels - activeTapePixels) / 2), 0)
+
+            # Bottom margin is equal due to centering of the tape
+            bottomMargin = topMargin
+
+            # Return active pixels / margins set
+            return (int(activeTapePixels), int(topMargin), int(bottomMargin))
+        else:
+            # Tape size not supported
+            raise ValueError(
+                f"Unsupported tape size {tapeSizeMM}mm. "
+                f"Supported sizes: {self.supportedTapeSizes}mm"
+            )

src/labelle/lib/devices/device_manager.py

@@ -8,6 +8,7 @@
     SUPPORTED_PRODUCTS,
     UNCONFIRMED_MESSAGE,
 )
+from labelle.lib.devices.device_config import DeviceConfig
 from labelle.lib.devices.usb_device import UsbDevice
 
 LOG = logging.getLogger(__name__)
@@ -80,8 +81,27 @@ def find_and_select_device(self, patterns: list[str] | None = None) -> UsbDevice
             LOG.debug(dev.device_info)
         dev = devices[0]
         if dev.is_supported:
-            msg = f"Recognized device as {SUPPORTED_PRODUCTS[dev.id_product]}"
+            foundDeviceConfig: DeviceConfig | None = get_device_config_by_id(
+                dev.id_product
+            )
+            if foundDeviceConfig is not None:
+                msg = f"Recognized device as {foundDeviceConfig.name}"
         else:
             msg = f"Unrecognized device: {hex(dev.id_product)}. {UNCONFIRMED_MESSAGE}"
         LOG.debug(msg)
         return dev
+
+
+def get_device_config_by_id(idValue: int) -> DeviceConfig | None:
+    """Get a labeler device config with USB ID.
+
+    :param idValue: USB ID value
+    :return: Device config, None if not found
+    """
+    #
+    for device in SUPPORTED_PRODUCTS:
+        if device.matches_device_id(idValue) is True:
+            return device
+
+    # No device config found
+    return None