Merge pull request hardbyte#849 from zariiii9003/xlSetApplConfig

Add methods get_application_config(), set_application_config() and set_timer_rate() to VectorBus

Author: mergify[bot]

can/interfaces/vector/canlib.py

@@ -10,7 +10,7 @@
 import logging
 import time
 import os
-from typing import Optional, Tuple
+from typing import List, Optional, Tuple
 
 import typing
 
@@ -152,29 +152,19 @@ def __init__(
         for channel in self.channels:
             if app_name:
                 # Get global channel index from application channel
-                hw_type = ctypes.c_uint(0)
-                hw_index = ctypes.c_uint(0)
-                hw_channel = ctypes.c_uint(0)
-                xldriver.xlGetApplConfig(
-                    self._app_name,
-                    channel,
-                    hw_type,
-                    hw_index,
-                    hw_channel,
-                    xldefine.XL_BusTypes.XL_BUS_TYPE_CAN.value,
+                hw_type, hw_index, hw_channel = self.get_application_config(
+                    app_name, channel, xldefine.XL_BusTypes.XL_BUS_TYPE_CAN
                 )
                 LOG.debug("Channel index %d found", channel)
-                idx = xldriver.xlGetChannelIndex(
-                    hw_type.value, hw_index.value, hw_channel.value
-                )
+                idx = xldriver.xlGetChannelIndex(hw_type.value, hw_index, hw_channel)
                 if idx < 0:
                     # Undocumented behavior! See issue #353.
                     # If hardware is unavailable, this function returns -1.
                     # Raise an exception as if the driver
                     # would have signalled XL_ERR_HW_NOT_PRESENT.
                     raise VectorError(
                         xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT.value,
-                        "XL_ERR_HW_NOT_PRESENT",
+                        xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT.name,
                         "xlGetChannelIndex",
                     )
             else:
@@ -634,15 +624,99 @@ def popup_vector_hw_configuration(wait_for_finish: int = 0) -> None:
         """
         xldriver.xlPopupHwConfig(ctypes.c_char_p(), ctypes.c_uint(wait_for_finish))
 
+    @staticmethod
+    def get_application_config(
+        app_name: str, app_channel: int, bus_type: xldefine.XL_BusTypes
+    ) -> Tuple[xldefine.XL_HardwareType, int, int]:
+        """Retrieve information for an application in Vector Hardware Configuration.
+
+        :param app_name:
+            The name of the application.
+        :param app_channel:
+            The channel of the application.
+        :param bus_type:
+            The bus type Enum e.g. `XL_BusTypes.XL_BUS_TYPE_CAN`
+        :return:
+            Returns a tuple of the hardware type, the hardware index and the
+            hardware channel.
+        :raises VectorError:
+            Raises a VectorError when the application name does not exist in
+            Vector Hardware Configuration.
+        """
+        hw_type = ctypes.c_uint()
+        hw_index = ctypes.c_uint()
+        hw_channel = ctypes.c_uint()
+
+        xldriver.xlGetApplConfig(
+            app_name.encode(),
+            app_channel,
+            hw_type,
+            hw_index,
+            hw_channel,
+            bus_type.value,
+        )
+        return xldefine.XL_HardwareType(hw_type.value), hw_index.value, hw_channel.value
+
+    @staticmethod
+    def set_application_config(
+        app_name: str,
+        app_channel: int,
+        hw_type: xldefine.XL_HardwareType,
+        hw_index: int,
+        hw_channel: int,
+        bus_type: xldefine.XL_BusTypes,
+    ) -> None:
+        """Modify the application settings in Vector Hardware Configuration.
+
+        :param app_name:
+            The name of the application. Creates a new application if it does
+            not exist yet.
+        :param app_channel:
+            The channel of the application.
+        :param hw_type:
+            The hardware type of the interface.
+            E.g XL_HardwareType.XL_HWTYPE_VIRTUAL
+        :param hw_index:
+            The index of the interface if multiple interface with the same
+            hardware type are present.
+        :param hw_channel:
+            The channel index of the interface.
+        :param bus_type:
+            The bus type of the interfaces, which should be
+            XL_BusTypes.XL_BUS_TYPE_CAN for most cases.
+        """
+        xldriver.xlSetApplConfig(
+            app_name.encode(),
+            app_channel,
+            hw_type.value,
+            hw_index,
+            hw_channel,
+            bus_type.value,
+        )
+
+    def set_timer_rate(self, timer_rate_ms: int) -> None:
+        """Set the cyclic event rate of the port.
+
+        Once set, the port will generate a cyclic event with the tag XL_EventTags.XL_TIMER.
+        This timer can be used to keep an application alive. See XL Driver Library Description
+        for more information
+
+        :param timer_rate_ms:
+            The timer rate in ms. The minimal timer rate is 1ms, a value of 0 deactivates
+            the timer events.
+        """
+        timer_rate_10us = timer_rate_ms * 100
+        xldriver.xlSetTimerRate(self.port_handle, timer_rate_10us)
+
 
-def get_channel_configs():
+def get_channel_configs() -> List[xlclass.XLchannelConfig]:
     if xldriver is None:
         return []
     driver_config = xlclass.XLdriverConfig()
     try:
         xldriver.xlOpenDriver()
         xldriver.xlGetDriverConfig(driver_config)
         xldriver.xlCloseDriver()
-    except Exception:
+    except VectorError:
         pass
     return [driver_config.channel[i] for i in range(driver_config.channelCount)]

can/interfaces/vector/xlclass.py

@@ -18,6 +18,8 @@
 XLstatus = ctypes.c_short
 XLportHandle = ctypes.c_long
 XLeventTag = ctypes.c_ubyte
+XLstringType = ctypes.c_char_p
+
 
 # structure for XL_RECEIVE_MSG, XL_TRANSMIT_MSG
 class s_xl_can_msg(ctypes.Structure):

can/interfaces/vector/xldefine.py

@@ -84,7 +84,8 @@ class XL_CANFD_RX_MessageFlags(Enum):
 
 
 class XL_CANFD_TX_EventTags(Enum):
-    XL_CAN_EV_TAG_TX_MSG = 1088
+    XL_CAN_EV_TAG_TX_MSG = 1088  # =0x0440
+    XL_CAN_EV_TAG_TX_ERRFR = 1089  # =0x0441
 
 
 class XL_CANFD_TX_MessageFlags(Enum):
@@ -158,13 +159,111 @@ class XL_Sizes(Enum):
 
 
 class XL_Status(Enum):
-    XL_SUCCESS = 0
-    XL_PENDING = 1
-    XL_ERR_QUEUE_IS_EMPTY = 10
-    XL_ERR_HW_NOT_PRESENT = 129
+    XL_SUCCESS = 0  # =0x0000
+    XL_PENDING = 1  # =0x0001
+    XL_ERR_QUEUE_IS_EMPTY = 10  # =0x000A
+    XL_ERR_QUEUE_IS_FULL = 11  # =0x000B
+    XL_ERR_TX_NOT_POSSIBLE = 12  # =0x000C
+    XL_ERR_NO_LICENSE = 14  # =0x000E
+    XL_ERR_WRONG_PARAMETER = 101  # =0x0065
+    XL_ERR_TWICE_REGISTER = 110  # =0x006E
+    XL_ERR_INVALID_CHAN_INDEX = 111  # =0x006F
+    XL_ERR_INVALID_ACCESS = 112  # =0x0070
+    XL_ERR_PORT_IS_OFFLINE = 113  # =0x0071
+    XL_ERR_CHAN_IS_ONLINE = 116  # =0x0074
+    XL_ERR_NOT_IMPLEMENTED = 117  # =0x0075
+    XL_ERR_INVALID_PORT = 118  # =0x0076
+    XL_ERR_HW_NOT_READY = 120  # =0x0078
+    XL_ERR_CMD_TIMEOUT = 121  # =0x0079
+    XL_ERR_HW_NOT_PRESENT = 129  # =0x0081
+    XL_ERR_NOTIFY_ALREADY_ACTIVE = 131  # =0x0083
+    XL_ERR_NO_RESOURCES = 152  # =0x0098
+    XL_ERR_WRONG_CHIP_TYPE = 153  # =0x0099
+    XL_ERR_WRONG_COMMAND = 154  # =0x009A
+    XL_ERR_INVALID_HANDLE = 155  # =0x009B
+    XL_ERR_RESERVED_NOT_ZERO = 157  # =0x009D
+    XL_ERR_INIT_ACCESS_MISSING = 158  # =0x009E
+    XL_ERR_CANNOT_OPEN_DRIVER = 201  # =0x00C9
+    XL_ERR_WRONG_BUS_TYPE = 202  # =0x00CA
+    XL_ERR_DLL_NOT_FOUND = 203  # =0x00CB
+    XL_ERR_INVALID_CHANNEL_MASK = 204  # =0x00CC
+    XL_ERR_NOT_SUPPORTED = 205  # =0x00CD
+    XL_ERR_CONNECTION_BROKEN = 210  # =0x00D2
+    XL_ERR_CONNECTION_CLOSED = 211  # =0x00D3
+    XL_ERR_INVALID_STREAM_NAME = 212  # =0x00D4
+    XL_ERR_CONNECTION_FAILED = 213  # =0x00D5
+    XL_ERR_STREAM_NOT_FOUND = 214  # =0x00D6
+    XL_ERR_STREAM_NOT_CONNECTED = 215  # =0x00D7
+    XL_ERR_QUEUE_OVERRUN = 216  # =0x00D8
+    XL_ERROR = 255  # =0x00FF
+
+    # CAN FD Error Codes
+    XL_ERR_INVALID_DLC = 513  # =0x0201
+    XL_ERR_INVALID_CANID = 514  # =0x0202
+    XL_ERR_INVALID_FDFLAG_MODE20 = 515  # =0x203
+    XL_ERR_EDL_RTR = 516  # =0x204
+    XL_ERR_EDL_NOT_SET = 517  # =0x205
+    XL_ERR_UNKNOWN_FLAG = 518  # =0x206
 
 
 class XL_TimeSyncNewValue(Enum):
     XL_SET_TIMESYNC_NO_CHANGE = 0
     XL_SET_TIMESYNC_ON = 1
     XL_SET_TIMESYNC_OFF = 2
+
+
+class XL_HardwareType(Enum):
+    XL_HWTYPE_NONE = 0
+    XL_HWTYPE_VIRTUAL = 1
+    XL_HWTYPE_CANCARDX = 2
+    XL_HWTYPE_CANAC2PCI = 6
+    XL_HWTYPE_CANCARDY = 12
+    XL_HWTYPE_CANCARDXL = 15
+    XL_HWTYPE_CANCASEXL = 21
+    XL_HWTYPE_CANCASEXL_LOG_OBSOLETE = 23
+    XL_HWTYPE_CANBOARDXL = 25
+    XL_HWTYPE_CANBOARDXL_PXI = 27
+    XL_HWTYPE_VN2600 = 29
+    XL_HWTYPE_VN2610 = XL_HWTYPE_VN2600
+    XL_HWTYPE_VN3300 = 37
+    XL_HWTYPE_VN3600 = 39
+    XL_HWTYPE_VN7600 = 41
+    XL_HWTYPE_CANCARDXLE = 43
+    XL_HWTYPE_VN8900 = 45
+    XL_HWTYPE_VN8950 = 47
+    XL_HWTYPE_VN2640 = 53
+    XL_HWTYPE_VN1610 = 55
+    XL_HWTYPE_VN1630 = 57
+    XL_HWTYPE_VN1640 = 59
+    XL_HWTYPE_VN8970 = 61
+    XL_HWTYPE_VN1611 = 63
+    XL_HWTYPE_VN5610 = 65
+    XL_HWTYPE_VN5620 = 66
+    XL_HWTYPE_VN7570 = 67
+    XL_HWTYPE_IPCLIENT = 69
+    XL_HWTYPE_IPSERVER = 71
+    XL_HWTYPE_VX1121 = 73
+    XL_HWTYPE_VX1131 = 75
+    XL_HWTYPE_VT6204 = 77
+    XL_HWTYPE_VN1630_LOG = 79
+    XL_HWTYPE_VN7610 = 81
+    XL_HWTYPE_VN7572 = 83
+    XL_HWTYPE_VN8972 = 85
+    XL_HWTYPE_VN0601 = 87
+    XL_HWTYPE_VN5640 = 89
+    XL_HWTYPE_VX0312 = 91
+    XL_HWTYPE_VH6501 = 94
+    XL_HWTYPE_VN8800 = 95
+    XL_HWTYPE_IPCL8800 = 96
+    XL_HWTYPE_IPSRV8800 = 97
+    XL_HWTYPE_CSMCAN = 98
+    XL_HWTYPE_VN5610A = 101
+    XL_HWTYPE_VN7640 = 102
+    XL_HWTYPE_VX1135 = 104
+    XL_HWTYPE_VN4610 = 105
+    XL_HWTYPE_VT6306 = 107
+    XL_HWTYPE_VT6104A = 108
+    XL_HWTYPE_VN5430 = 109
+    XL_HWTYPE_VN1530 = 112
+    XL_HWTYPE_VN1531 = 113
+    XL_MAX_HWTYPE = 113

can/interfaces/vector/xldriver.py

@@ -27,7 +27,7 @@
 # ctypes wrapping for API functions
 xlGetErrorString = _xlapi_dll.xlGetErrorString
 xlGetErrorString.argtypes = [xlclass.XLstatus]
-xlGetErrorString.restype = ctypes.c_char_p
+xlGetErrorString.restype = xlclass.XLstringType
 
 
 def check_status(result, function, arguments):
@@ -63,6 +63,18 @@ def check_status(result, function, arguments):
 xlGetApplConfig.restype = xlclass.XLstatus
 xlGetApplConfig.errcheck = check_status
 
+xlSetApplConfig = _xlapi_dll.xlSetApplConfig
+xlSetApplConfig.argtypes = [
+    ctypes.c_char_p,
+    ctypes.c_uint,
+    ctypes.c_uint,
+    ctypes.c_uint,
+    ctypes.c_uint,
+    ctypes.c_uint,
+]
+xlSetApplConfig.restype = xlclass.XLstatus
+xlSetApplConfig.errcheck = check_status
+
 xlGetChannelIndex = _xlapi_dll.xlGetChannelIndex
 xlGetChannelIndex.argtypes = [ctypes.c_int, ctypes.c_int, ctypes.c_int]
 xlGetChannelIndex.restype = ctypes.c_int
@@ -234,3 +246,16 @@ def check_status(result, function, arguments):
 xlPopupHwConfig.argtypes = [ctypes.c_char_p, ctypes.c_uint]
 xlPopupHwConfig.restype = xlclass.XLstatus
 xlPopupHwConfig.errcheck = check_status
+
+xlSetTimerRate = _xlapi_dll.xlSetTimerRate
+xlSetTimerRate.argtypes = [xlclass.XLportHandle, ctypes.c_ulong]
+xlSetTimerRate.restype = xlclass.XLstatus
+xlSetTimerRate.errcheck = check_status
+
+xlGetEventString = _xlapi_dll.xlGetEventString
+xlGetEventString.argtypes = [ctypes.POINTER(xlclass.XLevent)]
+xlGetEventString.restype = xlclass.XLstringType
+
+xlCanGetEventString = _xlapi_dll.xlCanGetEventString
+xlCanGetEventString.argtypes = [ctypes.POINTER(xlclass.XLcanRxEvent)]
+xlCanGetEventString.restype = xlclass.XLstringType

test/test_vector.py

@@ -249,6 +249,35 @@ def test_popup_hw_cfg(self) -> None:
         assert isinstance(args[0], ctypes.c_char_p)
         assert isinstance(args[1], ctypes.c_uint)
 
+    def test_get_application_config(self) -> None:
+        canlib.xldriver.xlGetApplConfig = Mock()
+        canlib.VectorBus.get_application_config(
+            app_name="CANalyzer",
+            app_channel=0,
+            bus_type=xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
+        )
+        assert canlib.xldriver.xlGetApplConfig.called
+
+    def test_set_application_config(self) -> None:
+        canlib.xldriver.xlSetApplConfig = Mock()
+        canlib.VectorBus.set_application_config(
+            app_name="CANalyzer",
+            app_channel=0,
+            hw_type=xldefine.XL_HardwareType.XL_HWTYPE_VN1610,
+            hw_index=0,
+            hw_channel=0,
+            bus_type=xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
+        )
+        assert canlib.xldriver.xlSetApplConfig.called
+
+    def test_set_timer_rate(self) -> None:
+        canlib.xldriver.xlSetTimerRate = Mock()
+        bus: canlib.VectorBus = can.Bus(
+            channel=0, bustype="vector", fd=True, _testing=True
+        )
+        bus.set_timer_rate(timer_rate_ms=1)
+        assert canlib.xldriver.xlSetTimerRate.called
+
     def test_called_without_testing_argument(self) -> None:
         """This tests if an exception is thrown when we are not running on Windows."""
         if os.name != "nt":