Merge branch 'develop' into feature/gs-usb-support

Author: hardbyte

.mergify.yml

@@ -1,10 +1,28 @@
 pull_request_rules:
-  - name: Automatic merge on up to date branch with dual approval
+  - name: Automatic merge passing PR on up to date branch with approving CR
     conditions:
-      - "#approved-reviews-by>=2"
+      - "#approved-reviews-by>=1"
+      - "#review-requested=0"
+      - "#changes-requested-reviews-by=0"
+      - "#commented-reviews-by=0"
       - "status-success=continuous-integration/travis-ci/pr"
       - "label!=work-in-progress"
     actions:
       merge:
         method: merge
-        strict: true
+        strict: smart+fasttrack
+  - name: Request Brian to review changes on core api.
+    conditions:
+      - "-files~=^can/interfaces/$"
+      - "-closed"
+      - "author!=hardbyte"
+    actions:
+      request_reviews:
+        users:
+          - hardbyte
+
+  - name: delete head branch after merge
+    conditions:
+      - merged
+    actions:
+      delete_head_branch: {}

README.rst

@@ -37,6 +37,10 @@ python-can
    :target: https://codecov.io/gh/hardbyte/python-can/branch/develop
    :alt: Test coverage reports on Codecov.io
 
+.. image:: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/hardbyte/python-can&style=flat
+   :target: https://mergify.io
+   :alt: Mergify Status
+
 The **C**\ ontroller **A**\ rea **N**\ etwork is a bus standard designed
 to allow microcontrollers and devices to communicate with each other. It
 has priority based bus arbitration and reliable deterministic

can/interfaces/ixxat/__init__.py

@@ -4,4 +4,4 @@
 Copyright (C) 2016 Giuseppe Corbelli <[email protected]>
 """
 
-from can.interfaces.ixxat.canlib import IXXATBus
+from can.interfaces.ixxat.canlib import IXXATBus, get_ixxat_hwids

can/interfaces/ixxat/canlib.py

@@ -800,3 +800,22 @@ def _format_can_status(status_flags: int):
         return "CAN status message: {}".format(", ".join(states))
     else:
         return "Empty CAN status message"
+
+
+def get_ixxat_hwids():
+    """Get a list of hardware ids of all available IXXAT devices."""
+    hwids = []
+    device_handle = HANDLE()
+    device_info = structures.VCIDEVICEINFO()
+
+    _canlib.vciEnumDeviceOpen(ctypes.byref(device_handle))
+    while True:
+        try:
+            _canlib.vciEnumDeviceNext(device_handle, ctypes.byref(device_info))
+        except StopIteration:
+            break
+        else:
+            hwids.append(device_info.UniqueHardwareId.AsChar.decode("ascii"))
+    _canlib.vciEnumDeviceClose(device_handle)
+
+    return hwids

can/interfaces/vector/canlib.py

@@ -102,7 +102,7 @@ def __init__(
         :param int serial:
             Serial number of the hardware to be used.
             If set, the channel parameter refers to the channels ONLY on the specified hardware.
-            If set, the app_name is unused.
+            If set, the app_name does not have to be previously defined in Vector Hardware Config.
         :param bool fd:
             If CAN-FD frames should be supported.
         :param int data_bitrate:
@@ -175,7 +175,7 @@ def __init__(
             if app_name:
                 # Get global channel index from application channel
                 hw_type, hw_index, hw_channel = self.get_application_config(
-                    app_name, channel, xldefine.XL_BusTypes.XL_BUS_TYPE_CAN
+                    app_name, channel
                 )
                 LOG.debug("Channel index %d found", channel)
                 idx = xldriver.xlGetChannelIndex(hw_type, hw_index, hw_channel)
@@ -609,19 +609,24 @@ def _detect_available_configs():
             ):
                 continue
             LOG.info(
-                "Channel index %d: %s",
-                channel_config.channelIndex,
-                channel_config.name.decode("ascii"),
+                "Channel index %d: %s", channel_config.channelIndex, channel_config.name
             )
             configs.append(
                 {
+                    # data for use in VectorBus.__init__():
                     "interface": "vector",
-                    "app_name": None,
-                    "channel": channel_config.channelIndex,
+                    "channel": channel_config.hwChannel,
+                    "serial": channel_config.serialNumber,
+                    # data for use in VectorBus.set_application_config():
+                    "hw_type": channel_config.hwType,
+                    "hw_index": channel_config.hwIndex,
+                    "hw_channel": channel_config.hwChannel,
+                    # additional information:
                     "supports_fd": bool(
-                        channel_config.channelBusCapabilities
+                        channel_config.channelCapabilities
                         & xldefine.XL_ChannelCapabilities.XL_CHANNEL_FLAG_CANFD_ISO_SUPPORT
                     ),
+                    "vector_channel_config": channel_config,
                 }
             )
         return configs
@@ -637,16 +642,14 @@ def popup_vector_hw_configuration(wait_for_finish: int = 0) -> None:
 
     @staticmethod
     def get_application_config(
-        app_name: str, app_channel: int, bus_type: xldefine.XL_BusTypes
+        app_name: str, app_channel: int
     ) -> 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.
@@ -659,7 +662,12 @@ def get_application_config(
         hw_channel = ctypes.c_uint()
 
         xldriver.xlGetApplConfig(
-            app_name.encode(), app_channel, hw_type, hw_index, hw_channel, bus_type
+            app_name.encode(),
+            app_channel,
+            hw_type,
+            hw_index,
+            hw_channel,
+            xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
         )
         return xldefine.XL_HardwareType(hw_type.value), hw_index.value, hw_channel.value
 
@@ -670,10 +678,19 @@ def set_application_config(
         hw_type: xldefine.XL_HardwareType,
         hw_index: int,
         hw_channel: int,
-        bus_type: xldefine.XL_BusTypes,
+        **kwargs,
     ) -> None:
         """Modify the application settings in Vector Hardware Configuration.
 
+        This method can also be used with a channel config dictionary::
+
+            import can
+            from can.interfaces.vector import VectorBus
+
+            configs = can.detect_available_configs(interfaces=['vector'])
+            cfg = configs[0]
+            VectorBus.set_application_config(app_name="MyApplication", app_channel=0, **cfg)
+
         :param app_name:
             The name of the application. Creates a new application if it does
             not exist yet.
@@ -687,12 +704,14 @@ def set_application_config(
             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, hw_index, hw_channel, bus_type
+            app_name.encode(),
+            app_channel,
+            hw_type,
+            hw_index,
+            hw_channel,
+            xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
         )
 
     def set_timer_rate(self, timer_rate_ms: int) -> None:
@@ -710,7 +729,23 @@ def set_timer_rate(self, timer_rate_ms: int) -> None:
         xldriver.xlSetTimerRate(self.port_handle, timer_rate_10us)
 
 
-def get_channel_configs() -> List[xlclass.XLchannelConfig]:
+class VectorChannelConfig(typing.NamedTuple):
+    name: str
+    hwType: xldefine.XL_HardwareType
+    hwIndex: int
+    hwChannel: int
+    channelIndex: int
+    channelMask: int
+    channelCapabilities: xldefine.XL_ChannelCapabilities
+    channelBusCapabilities: xldefine.XL_BusCapabilities
+    isOnBus: bool
+    connectedBusType: xldefine.XL_BusTypes
+    serialNumber: int
+    articleNumber: int
+    transceiverName: str
+
+
+def get_channel_configs() -> List[VectorChannelConfig]:
     if xldriver is None:
         return []
     driver_config = xlclass.XLdriverConfig()
@@ -720,4 +755,28 @@ def get_channel_configs() -> List[xlclass.XLchannelConfig]:
         xldriver.xlCloseDriver()
     except VectorError:
         pass
-    return [driver_config.channel[i] for i in range(driver_config.channelCount)]
+
+    channel_list: List[VectorChannelConfig] = []
+    for i in range(driver_config.channelCount):
+        xlcc: xlclass.XLchannelConfig = driver_config.channel[i]
+        vcc = VectorChannelConfig(
+            name=xlcc.name.decode(),
+            hwType=xldefine.XL_HardwareType(xlcc.hwType),
+            hwIndex=xlcc.hwIndex,
+            hwChannel=xlcc.hwChannel,
+            channelIndex=xlcc.channelIndex,
+            channelMask=xlcc.channelMask,
+            channelCapabilities=xldefine.XL_ChannelCapabilities(
+                xlcc.channelCapabilities
+            ),
+            channelBusCapabilities=xldefine.XL_BusCapabilities(
+                xlcc.channelBusCapabilities
+            ),
+            isOnBus=bool(xlcc.isOnBus),
+            connectedBusType=xldefine.XL_BusTypes(xlcc.connectedBusType),
+            serialNumber=xlcc.serialNumber,
+            articleNumber=xlcc.articleNumber,
+            transceiverName=xlcc.transceiverName.decode(),
+        )
+        channel_list.append(vcc)
+    return channel_list

can/interfaces/vector/xldefine.py

@@ -4,7 +4,7 @@
 
 # Import Python Modules
 # ==============================
-from enum import IntEnum
+from enum import IntEnum, IntFlag
 
 
 MAX_MSG_LEN = 8
@@ -22,7 +22,7 @@ class XL_AcceptanceFilter(IntEnum):
     XL_CAN_EXT = 2
 
 
-class XL_BusCapabilities(IntEnum):
+class XL_BusCapabilities(IntFlag):
     XL_BUS_COMPATIBLE_CAN = 1
     XL_BUS_ACTIVE_CAP_CAN = 65536
 
@@ -35,8 +35,17 @@ class XL_BusStatus(IntEnum):
 
 
 class XL_BusTypes(IntEnum):
-    XL_BUS_TYPE_NONE = 0
-    XL_BUS_TYPE_CAN = 1
+    XL_BUS_TYPE_NONE = 0  # =0x00000000
+    XL_BUS_TYPE_CAN = 1  # =0x00000001
+    XL_BUS_TYPE_LIN = 2  # =0x00000002
+    XL_BUS_TYPE_FLEXRAY = 4  # =0x00000004
+    XL_BUS_TYPE_AFDX = 8  # =0x00000008
+    XL_BUS_TYPE_MOST = 16  # =0x00000010
+    XL_BUS_TYPE_DAIO = 64  # =0x00000040
+    XL_BUS_TYPE_J1708 = 256  # =0x00000100
+    XL_BUS_TYPE_KLINE = 2048  # =0x00000800
+    XL_BUS_TYPE_ETHERNET = 4096  # =0x00001000
+    XL_BUS_TYPE_A429 = 8192  # =0x00002000
 
 
 class XL_CANFD_BusParams_CanOpMode(IntEnum):
@@ -97,7 +106,7 @@ class XL_CANFD_TX_MessageFlags(IntEnum):
     XL_CAN_TXMSG_FLAG_WAKEUP = 512
 
 
-class XL_ChannelCapabilities(IntEnum):
+class XL_ChannelCapabilities(IntFlag):
     XL_CHANNEL_FLAG_TIME_SYNC_RUNNING = 1
     XL_CHANNEL_FLAG_NO_HWSYNC_SUPPORT = 1024
     XL_CHANNEL_FLAG_SPDIF_CAPABLE = 16384
@@ -106,6 +115,10 @@ class XL_ChannelCapabilities(IntEnum):
     XL_CHANNEL_FLAG_CANFD_ISO_SUPPORT = 2147483648
 
 
+class XL_EventFlags(IntEnum):
+    XL_EVENT_FLAG_OVERRUN = 1
+
+
 class XL_EventTags(IntEnum):
     XL_NO_COMMAND = 0
     XL_RECEIVE_MSG = 1
@@ -135,7 +148,6 @@ class XL_MessageFlags(IntEnum):
     XL_CAN_MSG_FLAG_TX_COMPLETED = 64
     XL_CAN_MSG_FLAG_TX_REQUEST = 128
     XL_CAN_MSG_FLAG_SRR_BIT_DOM = 512
-    XL_EVENT_FLAG_OVERRUN = 1
 
 
 class XL_MessageFlagsExtended(IntEnum):
@@ -266,4 +278,6 @@ class XL_HardwareType(IntEnum):
     XL_HWTYPE_VN5430 = 109
     XL_HWTYPE_VN1530 = 112
     XL_HWTYPE_VN1531 = 113
-    XL_MAX_HWTYPE = 113
+    XL_HWTYPE_VX1161A = 114
+    XL_HWTYPE_VX1161B = 115
+    XL_MAX_HWTYPE = 119

doc/interfaces/ixxat.rst

@@ -53,6 +53,16 @@ The can_id/mask must be specified according to IXXAT behaviour, that is
 bit 0 of can_id/mask parameters represents the RTR field in CAN frame. See IXXAT
 VCI documentation, section "Message filters" for more info.
 
+List available devices
+-----------------
+In case you have connected multiple IXXAT devices, you have to select them by using their unique hardware id.
+To get a list of all connected IXXAT you can use the function ``get_ixxat_hwids()`` as demonstrated below:
+
+    >>> from can.interfaces.ixxat import get_ixxat_hwids
+    >>> for hwid in get_ixxat_hwids(): print("Found IXXAT with hardware id '%s'." % hwid)
+    Found IXXAT with hardware id 'HW441489'.
+    Found IXXAT with hardware id 'HW107422'.
+
 
 Internals
 ---------

setup.py

@@ -79,6 +79,8 @@
     # see https://www.python.org/dev/peps/pep-0345/#version-specifiers
     python_requires=">=3.6",
     install_requires=[
+        # Setuptools provides pkg_resources which python-can makes use of.
+        "setuptools",
         "wrapt~=1.10",
         'windows-curses;platform_system=="Windows"',
         "filelock",

test/test_vector.py

@@ -249,11 +249,7 @@ def test_popup_hw_cfg(self) -> None:
 
     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,
-        )
+        canlib.VectorBus.get_application_config(app_name="CANalyzer", app_channel=0)
         assert canlib.xldriver.xlGetApplConfig.called
 
     def test_set_application_config(self) -> None:
@@ -264,7 +260,6 @@ def test_set_application_config(self) -> None:
             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