screw it, we can split vin.py and vin_query.py later. this is nicer

Author: sshane

opendbc/car/fw_query_definitions.py

@@ -28,6 +28,21 @@ def p16(val):
   return struct.pack("!H", val)
 
 
+@dataclass
+class Vin:
+  vin: str
+  wmi: str = field(init=False)
+  vds: str = field(init=False)
+  vis: str = field(init=False)
+
+  def __post_init__(self):
+    # parses VIN in accordance with North America standard >2000 vehicles:
+    # https://en.wikipedia.org/wiki/Vehicle_identification_number#Components
+    self.wmi = self.vin[:3]  # World Manufacturer Identifier
+    self.vds = self.vin[3:9]  # Vehicle Descriptor Section
+    self.vis = self.vin[9:17]  # Vehicle Identifier Section
+
+
 class StdQueries:
   # FW queries
   TESTER_PRESENT_REQUEST = bytes([uds.SERVICE_TYPE.TESTER_PRESENT, 0x0])
@@ -103,7 +118,7 @@ class FwQueryConfig:
   extra_ecus: list[tuple[Ecu, int, int | None]] = field(default_factory=list)
   # Function a brand can implement to provide better fuzzy matching. Takes in FW versions and VIN,
   # returns set of candidates. Only will match if one candidate is returned
-  match_fw_to_car_fuzzy: Callable[[LiveFwVersions, str, OfflineFwVersions], set[str]] | None = None
+  match_fw_to_car_fuzzy: Callable[[LiveFwVersions, Vin, OfflineFwVersions], set[str]] | None = None
 
   def __post_init__(self):
     # Asserts that a request exists if extra ecus are used

opendbc/car/fw_versions.py

@@ -10,7 +10,7 @@
 from opendbc.car.structs import CarParams
 from opendbc.car.ecu_addrs import get_ecu_addrs
 from opendbc.car.fingerprints import FW_VERSIONS
-from opendbc.car.fw_query_definitions import ESSENTIAL_ECUS, AddrType, EcuAddrBusType, FwQueryConfig, LiveFwVersions, OfflineFwVersions
+from opendbc.car.fw_query_definitions import ESSENTIAL_ECUS, AddrType, EcuAddrBusType, FwQueryConfig, LiveFwVersions, OfflineFwVersions, Vin
 from opendbc.car.interfaces import get_interface_attr
 from opendbc.car.isotp_parallel_query import IsoTpParallelQuery
 
@@ -161,7 +161,7 @@ def match_fw_to_car(fw_versions: list[CarParams.CarFw], vin: str, allow_exact: b
       # If specified and no matches so far, fall back to brand's fuzzy fingerprinting function
       config = FW_QUERY_CONFIGS[brand]
       if not exact_match and not len(matches) and config.match_fw_to_car_fuzzy is not None:
-        matches |= config.match_fw_to_car_fuzzy(fw_versions_dict, vin, VERSIONS[brand])
+        matches |= config.match_fw_to_car_fuzzy(fw_versions_dict, Vin(vin), VERSIONS[brand])
 
     if len(matches):
       return exact_match, matches

opendbc/car/tests/test_fw_fingerprint.py

@@ -7,6 +7,7 @@
 from opendbc.car.car_helpers import interfaces
 from opendbc.car.structs import CarParams
 from opendbc.car.fingerprints import FW_VERSIONS
+from opendbc.car.fw_query_definitions import Vin
 from opendbc.car.fw_versions import FW_QUERY_CONFIGS, FUZZY_EXCLUDE_ECUS, VERSIONS, build_fw_dict, \
                                     match_fw_to_car, get_brand_ecu_matches, get_fw_versions, get_present_ecus
 from opendbc.car.vin import get_vin
@@ -64,7 +65,7 @@ def test_custom_fuzzy_match(self, brand, car_model, ecus):
                         address=addr, subAddress=0 if sub_addr is None else sub_addr))
       CP.carFw = fw
       _, matches = match_fw_to_car(CP.carFw, CP.carVin, allow_exact=False, log=False)
-      brand_matches = config.match_fw_to_car_fuzzy(build_fw_dict(CP.carFw), CP.carVin, VERSIONS[brand])
+      brand_matches = config.match_fw_to_car_fuzzy(build_fw_dict(CP.carFw), Vin(CP.carVin), VERSIONS[brand])
 
       # If both have matches, they must agree
       if len(matches) == 1 and len(brand_matches) == 1:

opendbc/car/vin.py

@@ -1,5 +1,4 @@
 import re
-from dataclasses import dataclass, field
 
 from opendbc.car import uds
 from opendbc.car.carlog import carlog
@@ -10,21 +9,6 @@
 VIN_RE = "[A-HJ-NPR-Z0-9]{17}"
 
 
-@dataclass
-class Vin:
-  vin: str
-  wmi: str = field(init=False)
-  vds: str = field(init=False)
-  vis: str = field(init=False)
-
-  def __post_init__(self):
-    # parses VIN in accordance with North America standard >2000 vehicles:
-    # https://en.wikipedia.org/wiki/Vehicle_identification_number#Components
-    self.wmi = self.vin[:3]  # World Manufacturer Identifier
-    self.vds = self.vin[3:9]  # Vehicle Descriptor Section
-    self.vis = self.vin[9:17]  # Vehicle Identifier Section
-
-
 def is_valid_vin(vin: str):
   return re.fullmatch(VIN_RE, vin) is not None
 

opendbc/car/volkswagen/tests/test_volkswagen.py

@@ -2,6 +2,7 @@
 import re
 
 from opendbc.car.structs import CarParams
+from opendbc.car.fw_query_definitions import Vin
 from opendbc.car.volkswagen.values import CAR, FW_QUERY_CONFIG, WMI
 from opendbc.car.volkswagen.fingerprints import FW_VERSIONS
 
@@ -46,7 +47,7 @@ def test_custom_fuzzy_fingerprinting(self, subtests):
             vin = ["0"] * 17
             vin[0:3] = wmi
             vin[6:8] = chassis_code
-            vin = "".join(vin)
+            vin = Vin("".join(vin))
 
             # Check a few FW cases - expected, unexpected
             for radar_fw in random.sample(all_radar_fw, 5) + [b'\xf1\x875Q0907572G \xf1\x890571', b'\xf1\x877H9907572AA\xf1\x890396']:

opendbc/car/volkswagen/values.py

@@ -8,7 +8,6 @@
 from opendbc.car.docs_definitions import CarFootnote, CarHarness, CarDocs, CarParts, Column, \
                                                      Device
 from opendbc.car.fw_query_definitions import EcuAddrSubAddr, FwQueryConfig, Request, p16
-from opendbc.car.vin import Vin
 
 Ecu = structs.CarParams.Ecu
 NetworkLocation = structs.CarParams.NetworkLocation
@@ -454,8 +453,7 @@ def match_fw_to_car_fuzzy(live_fw_versions, vin, offline_fw_versions) -> set[str
 
   # Check the WMI and chassis code to determine the platform
   # https://www.clubvw.org.au/vwreference/vwvin
-  vin_obj = Vin(vin)
-  chassis_code = vin_obj.vds[3:5]
+  chassis_code = vin.vds[3:5]
 
   for platform in CAR:
     valid_ecus = set()
@@ -475,7 +473,7 @@ def match_fw_to_car_fuzzy(live_fw_versions, vin, offline_fw_versions) -> set[str
     if valid_ecus != CHECK_FUZZY_ECUS:
       continue
 
-    if vin_obj.wmi in platform.config.wmis and chassis_code in platform.config.chassis_codes:
+    if vin.wmi in platform.config.wmis and chassis_code in platform.config.chassis_codes:
       candidates.add(platform)
 
   return {str(c) for c in candidates}