Fix support for map testing (#15)

jverkoey · web-flow · commit 20f4b0200264 · 2025-02-18T16:42:37.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+__pycache__
diff --git a/python/command_registry.py b/python/command_registry.py
@@ -3,7 +3,7 @@
 from enum import Enum
 
 from .can_frame import CANFrame, CANPacket, CANFrameScanner, CANIDFormat
-from .signals import Command, Scaling
+from .signals import Command, Enumeration, Scaling, SignalSet
 
 class ServiceType(Enum):
     SERVICE_21 = 0x21
@@ -71,12 +71,14 @@ def _extract_service_22_commands(self, can_id: str, data: bytes) -> List[Command
                 values = {}
                 remaining_data = data
                 for signal in command.signals:
-                    if isinstance(signal.format, Scaling):
-                        try:
+                    try:
+                        if isinstance(signal.format, Scaling):
                             value = signal.format.decode_value(remaining_data)
-                            values[signal.id] = value
-                        except Exception as e:
-                            print(f"Error decoding signal {signal.id}: {e}")
+                        elif isinstance(signal.format, Enumeration):
+                            value = signal.format.decode_value(remaining_data)
+                        values[signal.id] = value
+                    except Exception as e:
+                        print(f"Error decoding signal {signal.id}: {e}")
 
                 responses.append(CommandResponse(command, remaining_data, values))
 
@@ -110,7 +112,10 @@ def _extract_service_21_commands(self, can_id: str, data: bytes) -> List[Command
                 for signal in command.signals:
                     if isinstance(signal.format, Scaling):
                         try:
-                            value = signal.format.decode_value(remaining_data)
+                            if isinstance(signal.format, Scaling):
+                                value = signal.format.decode_value(remaining_data)
+                            elif isinstance(signal.format, Enumeration):
+                                value = signal.format.decode_value(remaining_data)
                             values[signal.id] = value
                         except Exception as e:
                             print(f"Error decoding signal {signal.id}: {e}")
diff --git a/python/signals.py b/python/signals.py
@@ -141,13 +141,21 @@ class EnumerationValue:
 @dataclass(frozen=True)
 class Enumeration:
     bit_length: int
-    map: Dict[int, EnumerationValue]
+    map: Dict[str, EnumerationValue]
     bit_offset: int = 0
 
+    def __hash__(self) -> int:
+        # Convert the map to a tuple of sorted items to make it hashable
+        map_items = tuple(sorted(
+            (k, hash(v))
+            for k, v in self.map.items()
+        ))
+        return hash((self.bit_length, map_items, self.bit_offset))
+
     @staticmethod
     def from_json(data: Dict) -> 'Enumeration':
         value_map = {
-            k: EnumerationValue(**v) if isinstance(v, dict) else EnumerationValue(str(v), str(v))
+            str(k): EnumerationValue(**v) if isinstance(v, dict) else EnumerationValue(str(v), str(v))
             for k, v in data['map'].items()
         }
         return Enumeration(
@@ -156,6 +164,22 @@ def from_json(data: Dict) -> 'Enumeration':
             map=value_map
         )
 
+    def decode_value(self, data: bytes) -> str:
+        """Decode an enumerated value from bytes."""
+        # First extract the raw value as an integer
+        raw_value = 0
+        for i in range(self.bit_length):
+            byte_idx = (self.bit_offset + i) // 8
+            bit_idx = 7 - ((self.bit_offset + i) % 8)  # MSB format
+            if byte_idx < len(data) and (data[byte_idx] & (1 << bit_idx)) != 0:
+                raw_value |= 1 << (self.bit_length - i - 1)
+
+        # Convert to string and look up in map
+        str_value = str(raw_value)
+        if str_value in self.map:
+            return self.map[str_value].value
+        return str_value  # Return raw value as string if no mapping exists
+
 @dataclass(frozen=True)
 class Signal:
     id: str
diff --git a/python/signals_testing.py b/python/signals_testing.py
@@ -1,5 +1,5 @@
 import pytest
-from typing import Dict, Any, Optional
+from typing import Any, Dict, Optional, Union
 
 from .can_frame import CANIDFormat
 from .command_registry import decode_obd_response
@@ -8,7 +8,7 @@
 def obd_testrunner(
         signalset_json: str,
         response_hex: str,
-        expected_values: Dict[str, float],
+        expected_values: Dict[str, Union[float, str]],  # Updated type hint
         can_id_format: CANIDFormat = CANIDFormat.ELEVEN_BIT,
         extended_addressing_enabled: Optional[bool] = None
     ):
@@ -17,7 +17,7 @@ def obd_testrunner(
     Args:
         signalset_json: JSON string containing the signal set definition
         response_hex: Hex string of the OBD response
-        expected_values: Dictionary mapping signal IDs to their expected values
+        expected_values: Dictionary mapping signal IDs to their expected values (numbers or strings)
     """
     signalset = SignalSet.from_json(signalset_json)
     actual_values = decode_obd_response(
@@ -31,5 +31,9 @@ def obd_testrunner(
     for signal_id, expected_value in expected_values.items():
         assert signal_id in actual_values, f"Signal {signal_id} not found in decoded response"
         actual_value = actual_values[signal_id]
-        assert pytest.approx(actual_value) == expected_value, \
-            f"Signal {signal_id} value mismatch: got {actual_value}, expected {expected_value}"
+        if isinstance(expected_value, (int, float)):
+            assert pytest.approx(actual_value) == expected_value, \
+                f"Signal {signal_id} value mismatch: got {actual_value}, expected {expected_value}"
+        else:
+            assert actual_value == expected_value, \
+                f"Signal {signal_id} value mismatch: got {actual_value}, expected {expected_value}"
diff --git a/python/test_f150.py b/python/test_f150.py
@@ -7,6 +7,10 @@
 REPO_ROOT = os.path.abspath(os.path.dirname(__file__))
 
 TEST_CASES = [
+    # 2024 model years
+    # Gear
+    ("7E804621E1203", {"F150_GEAR": "3"}),
+
     # 2021 model year
     # Target vehicle speed - -61.2 km/h
     ("76C0562A224FF56", {"F150_CC_TGT_VSS": -61.2}),
diff --git a/python/testdata/ford-f-150.json b/python/testdata/ford-f-150.json
@@ -1,55 +1,55 @@
 { "commands": [
-    { "hdr": "720", "rax": "728", "cmd": {"22": "404C"}, "freq": 5,
-      "signals": [
-        {"id": "F150_ODO", "path": "Trips", "fmt": { "len": 24, "max": 1677721, "div": 10, "unit": "kilometers" }, "name": "Odometer (Instrument panel)", "suggestedMetric": "odometer"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2813"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_FL", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Front left tire pressure", "suggestedMetric": "frontLeftTirePressure"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2814"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_FR", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Front right tire pressure", "suggestedMetric": "frontRightTirePressure"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2815"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_RRO", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear right outer tire pressure", "suggestedMetric": "rearRightTirePressure"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2816"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_RLO", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear left outer tire pressure", "suggestedMetric": "rearLeftTirePressure"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2817"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_RRI", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear right inner tire pressure"}
-      ]},
-    { "hdr": "726", "rax": "72E", "cmd": {"22": "2818"}, "freq": 5,
-      "signals": [
-        {"id": "F150_TP_RLI", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear left inner tire pressure"}
-      ]},
-    { "hdr": "760", "rax": "768", "cmd": {"22": "3201"}, "freq": 0.25,
-      "signals": [
-        {"id": "F150_STEER_ANGLE", "path": "Control", "fmt": { "len": 16, "max": 1638, "min": -1638, "div": 20, "add": -1638.4, "unit": "degrees" }, "name": "Steering wheel angle (ABS)", "description": "Positive is rotated to the left, negative is rotated to the right."}
-      ]},
-    { "hdr": "764", "cmd": {"22": "A224"}, "freq": 0.25,
-      "signals": [
-        {"id": "F150_CC_TGT_VSS", "path": "Cruise control", "fmt": { "len": 16, "max": 736, "min": -736, "mul": 3.6, "div": 10, "sign": true, "unit": "kilometersPerHour" }, "name": "Target vehicle speed", "description": "The speed of the vehicle ahead of you."}
-      ]},
-    { "hdr": "7DF", "cmd": {"22": "1E12"}, "freq": 2,
-      "signals": [
-        {"id": "F150_GEAR", "path": "Engine", "fmt": { "len": 8, "max": 255, "unit": "scalar" }, "name": "Current gear", "description": "The automatic transmission gear. Numbers aren't yet mapped to named gears."}
-      ]},
-    { "hdr": "7DF", "cmd": {"22": "1E1C"}, "freq": 1,
-      "signals": [
-        {"id": "F150_TOT", "path": "Engine", "fmt": { "len": 16, "max": 255, "div": 16, "unit": "celsius" }, "name": "Transmission oil temperature"}
-      ]},
-    { "hdr": "7DF", "cmd": {"22": "1E23"}, "freq": 2,
-      "signals": [
-        {"id": "F150_GEAR_SHFT", "path": "Engine", "fmt": { "len": 8, "max": 255, "unit": "scalar" }, "name": "Shift gear"}
-      ]},
-    { "hdr": "7E0", "rax": "7E8", "cmd": {"22": "F42F"}, "freq": 1,
-      "signals": [
-        {"id": "F150_FLI", "path": "Fuel", "fmt": { "len": 8, "max": 255, "mul": 100, "div": 255, "unit": "percent" }, "name": "Fuel level", "suggestedMetric": "fuelTankLevel"}
-      ]}
-    ]
-    }
+  { "hdr": "720", "rax": "728", "cmd": {"22": "404C"}, "freq": 5,
+    "signals": [
+      {"id": "F150_ODO", "path": "Trips", "fmt": { "len": 24, "max": 1677721, "div": 10, "unit": "kilometers" }, "name": "Odometer (Instrument panel)", "suggestedMetric": "odometer"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2813"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_FL", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Front left tire pressure", "suggestedMetric": "frontLeftTirePressure"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2814"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_FR", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Front right tire pressure", "suggestedMetric": "frontRightTirePressure"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2815"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_RRO", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear right outer tire pressure", "suggestedMetric": "rearRightTirePressure"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2816"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_RLO", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear left outer tire pressure", "suggestedMetric": "rearLeftTirePressure"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2817"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_RRI", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear right inner tire pressure"}
+    ]},
+  { "hdr": "726", "rax": "72E", "cmd": {"22": "2818"}, "freq": 5,
+    "signals": [
+      {"id": "F150_TP_RLI", "path": "Tires", "fmt": { "len": 16, "max": 3276, "div": 20, "unit": "psi" }, "name": "Rear left inner tire pressure"}
+    ]},
+  { "hdr": "760", "rax": "768", "cmd": {"22": "3201"}, "freq": 0.25,
+    "signals": [
+      {"id": "F150_STEER_ANGLE", "path": "Control", "fmt": { "len": 16, "max": 1638, "min": -1638, "div": 20, "add": -1638.4, "unit": "degrees" }, "name": "Steering wheel angle (ABS)", "description": "Positive is rotated to the left, negative is rotated to the right."}
+    ]},
+  { "hdr": "764", "cmd": {"22": "A224"}, "freq": 0.25,
+    "signals": [
+      {"id": "F150_CC_TGT_VSS", "path": "Cruise control", "fmt": { "len": 16, "max": 736, "min": -736, "mul": 3.6, "div": 10, "sign": true, "unit": "kilometersPerHour" }, "name": "Target vehicle speed", "description": "The speed of the vehicle ahead of you."}
+    ]},
+  { "hdr": "7DF", "cmd": {"22": "1E1C"}, "freq": 1,
+    "signals": [
+      {"id": "F150_TOT", "path": "Engine", "fmt": { "len": 16, "max": 255, "div": 16, "unit": "celsius" }, "name": "Transmission oil temperature"}
+    ]},
+  { "hdr": "7DF", "cmd": {"22": "1E23"}, "freq": 2,
+    "signals": [
+      {"id": "F150_GEAR_SHFT", "path": "Engine", "fmt": { "len": 8, "max": 255, "unit": "scalar" }, "name": "Shift gear"}
+    ]},
+  { "hdr": "7E0", "rax": "7E8", "cmd": {"22": "1E12"}, "freq": 2,
+    "signals": [
+      {"id": "F150_GEAR", "path": "Engine", "fmt": { "len": 8, "map": {"1":{"description":"First gear","value":"1"},"10":{"description":"Manual","value":"Manul"},"2":{"description":"Second gear","value":"2"},"3":{"description":"Third gear","value":"3"},"4":{"description":"Fourth gear","value":"4"},"46":{"description":"Drive","value":"DRIVE"},"5":{"description":"Fifth gear","value":"5"},"50":{"description":"Neutral","value":"NEUTRAL"},"6":{"description":"Sixth gear","value":"6"},"60":{"description":"Reverse","value":"REVERSE"},"7":{"description":"Seventh gear","value":"7"},"70":{"description":"Park","value":"PARK"},"8":{"description":"Eighth gear","value":"8"},"9":{"description":"Ninth gear","value":"9"}} }, "name": "Current gear", "description": "The automatic transmission gear."}
+    ]},
+  { "hdr": "7E0", "rax": "7E8", "cmd": {"22": "F42F"}, "freq": 1,
+    "signals": [
+      {"id": "F150_FLI", "path": "Fuel", "fmt": { "len": 8, "max": 255, "mul": 100, "div": 255, "unit": "percent" }, "name": "Fuel level", "suggestedMetric": "fuelTankLevel"}
+    ]}
+  ]
+  }
