usb: consolidate USB VID/PID definitions

These were scattered about and repeated or hard-coded in various places.

Author: dlech

pybricksdev/connections/ev3.py

@@ -10,10 +10,7 @@
 import hid
 
 from pybricksdev.tools import chunk
-
-LEGO_VENDOR_ID = 0x0694
-EV3_PRODUCT_ID = 0x0005
-EV3_BOOTLOADER_PRODUCT_ID = 0x0006
+from pybricksdev.usb import EV3_BOOTLOADER_USB_PID, LEGO_USB_VID
 
 
 class MessageType(enum.IntEnum):
@@ -70,9 +67,7 @@ def open(self) -> None:
         """
         Opens an HID connection to the EV3 bootloader.
         """
-        self._device.open(
-            vendor_id=LEGO_VENDOR_ID, product_id=EV3_BOOTLOADER_PRODUCT_ID
-        )
+        self._device.open(vendor_id=LEGO_USB_VID, product_id=EV3_BOOTLOADER_USB_PID)
 
     def close(self) -> None:
         """

pybricksdev/connections/lego.py

@@ -9,6 +9,7 @@
 
 from pybricksdev.connections.pybricks import PybricksHub
 from pybricksdev.tools import chunk
+from pybricksdev.usb import LEGO_USB_VID
 
 FILE_PACKET_SIZE = 1024
 FILE_TRANSFER_SCRIPT = f"""
@@ -77,7 +78,10 @@ async def connect(self, device=None):
         port = None
         devices = list_ports.comports()
         for dev in devices:
-            if dev.product == "LEGO Technic Large Hub in FS Mode" or dev.vid == 0x0694:
+            if (
+                dev.product == "LEGO Technic Large Hub in FS Mode"
+                or dev.vid == LEGO_USB_VID
+            ):
                 port = dev.device
                 break
 

pybricksdev/dfu.py

@@ -16,20 +16,23 @@
 from pybricksdev import resources
 from pybricksdev._vendored import dfu_create, dfu_upload
 from pybricksdev.ble.lwp3.bytecodes import HubKind
+from pybricksdev.usb import (
+    LEGO_USB_VID,
+    MINDSTORMS_INVENTOR_DFU_USB_PID,
+    SPIKE_ESSENTIAL_DFU_USB_PID,
+    SPIKE_PRIME_DFU_USB_PID,
+)
 
 FIRMWARE_ADDRESS = 0x08008000
 FIRMWARE_SIZE = 1 * 1024 * 1024 - 32 * 1024  # 1MiB - 32KiB
-LEGO_VID = 0x0694
-SPIKE_PRIME_PID = 0x0008
-SPIKE_ESSENTIAL_PID = 0x000C
-MINDSTORMS_INVENTOR_PID = 0x0011
+
 
 ALL_PIDS = {
-    MINDSTORMS_INVENTOR_PID: HubKind.TECHNIC_LARGE,
-    SPIKE_ESSENTIAL_PID: HubKind.TECHNIC_SMALL,
-    SPIKE_PRIME_PID: HubKind.TECHNIC_LARGE,
+    MINDSTORMS_INVENTOR_DFU_USB_PID: HubKind.TECHNIC_LARGE,
+    SPIKE_ESSENTIAL_DFU_USB_PID: HubKind.TECHNIC_SMALL,
+    SPIKE_PRIME_DFU_USB_PID: HubKind.TECHNIC_LARGE,
 }
-ALL_DEVICES = [f"{LEGO_VID:04x}:{pid:04x}" for pid in ALL_PIDS.keys()]
+ALL_DEVICES = [f"{LEGO_USB_VID:04x}:{pid:04x}" for pid in ALL_PIDS.keys()]
 
 
 def _get_dfu_util() -> ContextManager[os.PathLike]:
@@ -165,7 +168,7 @@ def flash_dfu(firmware_bin: bytes, metadata: dict) -> None:
         try:
             # Determine correct product ID
 
-            devices = dfu_upload.get_dfu_devices(idVendor=LEGO_VID)
+            devices = dfu_upload.get_dfu_devices(idVendor=LEGO_USB_VID)
             if not devices:
                 print(
                     "No DFU devices found.",
@@ -184,11 +187,11 @@ def flash_dfu(firmware_bin: bytes, metadata: dict) -> None:
                 exit(1)
 
             # Create dfu file
-            device = "0x{0:04x}:0x{1:04x}".format(LEGO_VID, product_id)
+            device = "0x{0:04x}:0x{1:04x}".format(LEGO_USB_VID, product_id)
             dfu_create.build(outfile, [[target]], device)
 
             # Init dfu tool
-            dfu_upload.__VID = LEGO_VID
+            dfu_upload.__VID = LEGO_USB_VID
             dfu_upload.__PID = product_id
             dfu_upload.init()
             elements = dfu_upload.read_dfu_file(outfile)

pybricksdev/usb/__init__.py

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 The Pybricks Authors
+
+# Official LEGO USB identifiers
+LEGO_USB_VID = 0x0694
+EV3_USB_PID = 0x0005
+EV3_BOOTLOADER_USB_PID = 0x0006
+SPIKE_PRIME_DFU_USB_PID = 0x0008
+SPIKE_ESSENTIAL_DFU_USB_PID = 0x000C
+MINDSTORMS_INVENTOR_DFU_USB_PID = 0x0011

pyproject.toml

@@ -78,6 +78,7 @@ target-version = ['py38']
 [tool.isort]
 profile = "black"
 src_paths = ["demo", "pybricksdev", "tests"]
+known_third_party = ["usb"]
 
 [tool.pytest.ini_options]
 asyncio_mode = "strict"