Implement CanProtocol for VectorBus

Author: lumagi

can/interfaces/vector/canlib.py

@@ -8,8 +8,9 @@
 # ==============================
 import ctypes
 import logging
-import time
 import os
+import time
+import warnings
 from types import ModuleType
 from typing import (
     List,
@@ -44,6 +45,7 @@
     CanInitializationError,
     BitTiming,
     BitTimingFd,
+    CanProtocol,
 )
 from can.util import (
     len2dlc,
@@ -203,7 +205,7 @@ def __init__(
         channel_configs = get_channel_configs()
 
         self.mask = 0
-        self.fd = isinstance(timing, BitTimingFd) if timing else fd
+        is_fd = isinstance(timing, BitTimingFd) if timing else fd
         self.channel_masks: Dict[int, int] = {}
         self.index_to_channel: Dict[int, int] = {}
 
@@ -228,7 +230,7 @@ def __init__(
 
         interface_version = (
             xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION_V4
-            if self.fd
+            if is_fd
             else xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION
         )
 
@@ -323,7 +325,21 @@ def __init__(
             self._time_offset = 0.0
 
         self._is_filtered = False
-        super().__init__(channel=channel, can_filters=can_filters, **kwargs)
+        super().__init__(
+            channel=channel,
+            can_filters=can_filters,
+            protocol=CanProtocol.CAN_FD if is_fd else CanProtocol.CAN_20,
+            **kwargs,
+        )
+
+    @property
+    def fd(self) -> bool:
+        warnings.warn(
+            "The VectorBus.fd property is deprecated and superseded by "
+            "BusABC.protocol. It is scheduled for removal in version 5.0.",
+            DeprecationWarning,
+        )
+        return self.protocol == CanProtocol.CAN_FD
 
     def _find_global_channel_idx(
         self,
@@ -646,7 +662,7 @@ def _recv_internal(
 
         while True:
             try:
-                if self.fd:
+                if self.protocol == CanProtocol.CAN_FD:
                     msg = self._recv_canfd()
                 else:
                     msg = self._recv_can()
@@ -780,7 +796,7 @@ def send(self, msg: Message, timeout: Optional[float] = None) -> None:
 
     def _send_sequence(self, msgs: Sequence[Message]) -> int:
         """Send messages and return number of successful transmissions."""
-        if self.fd:
+        if self.protocol == CanProtocol.CAN_FD:
             return self._send_can_fd_msg_sequence(msgs)
         else:
             return self._send_can_msg_sequence(msgs)

test/test_vector.py

@@ -79,6 +79,8 @@ def mock_xldriver() -> None:
 def test_bus_creation_mocked(mock_xldriver) -> None:
     bus = can.Bus(channel=0, interface="vector", _testing=True)
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_20
+
     can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()
     can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()
 
@@ -95,6 +97,8 @@ def test_bus_creation_mocked(mock_xldriver) -> None:
 def test_bus_creation() -> None:
     bus = can.Bus(channel=0, serial=_find_virtual_can_serial(), interface="vector")
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_20
+
     bus.shutdown()
 
     xl_channel_config = _find_xl_channel_config(
@@ -108,12 +112,15 @@ def test_bus_creation() -> None:
 
     bus = canlib.VectorBus(channel=0, serial=_find_virtual_can_serial())
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_20
     bus.shutdown()
 
 
 def test_bus_creation_bitrate_mocked(mock_xldriver) -> None:
     bus = can.Bus(channel=0, interface="vector", bitrate=200_000, _testing=True)
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_20
+
     can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()
     can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()
 
@@ -139,6 +146,7 @@ def test_bus_creation_bitrate() -> None:
         bitrate=200_000,
     )
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_20
 
     xl_channel_config = _find_xl_channel_config(
         serial=_find_virtual_can_serial(), channel=0
@@ -151,6 +159,8 @@ def test_bus_creation_bitrate() -> None:
 def test_bus_creation_fd_mocked(mock_xldriver) -> None:
     bus = can.Bus(channel=0, interface="vector", fd=True, _testing=True)
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_FD
+
     can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()
     can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()
 
@@ -171,6 +181,7 @@ def test_bus_creation_fd() -> None:
         channel=0, serial=_find_virtual_can_serial(), interface="vector", fd=True
     )
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_FD
 
     xl_channel_config = _find_xl_channel_config(
         serial=_find_virtual_can_serial(), channel=0
@@ -202,6 +213,8 @@ def test_bus_creation_fd_bitrate_timings_mocked(mock_xldriver) -> None:
         _testing=True,
     )
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_FD
+
     can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()
     can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()
 
@@ -344,6 +357,7 @@ def test_bus_creation_timing() -> None:
             timing=timing,
         )
         assert isinstance(bus, canlib.VectorBus)
+        assert bus.protocol == can.CanProtocol.CAN_20
 
         xl_channel_config = _find_xl_channel_config(
             serial=_find_virtual_can_serial(), channel=0
@@ -375,6 +389,8 @@ def test_bus_creation_timingfd_mocked(mock_xldriver) -> None:
         _testing=True,
     )
     assert isinstance(bus, canlib.VectorBus)
+    assert bus.protocol == can.CanProtocol.CAN_FD
+
     can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()
     can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()
 
@@ -423,6 +439,8 @@ def test_bus_creation_timingfd() -> None:
         timing=timing,
     )
 
+    assert bus.protocol == can.CanProtocol.CAN_FD
+
     xl_channel_config = _find_xl_channel_config(
         serial=_find_virtual_can_serial(), channel=0
     )