Merge branch 'develop' into add_typing_for_slcan_interface

Author: karlding

.pylintrc

@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

.pylintrc-wip

@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

.travis.yml

@@ -81,14 +81,12 @@ jobs:
         # re-introduced
         # check the entire main codebase
         - pylint --rcfile=.pylintrc-wip can/**.py
-        # check setup.py
-        - pylint --rcfile=.pylintrc *.py
-        # check doc/conf.py and possible other scripts in there
-        - pylint --rcfile=.pylintrc doc/**.py
+        - pylint --rcfile=.pylintrc setup.py
+        - pylint --rcfile=.pylintrc doc.conf
         # check the scripts folder
-        - pylint --rcfile=.pylintrc scripts/**.py
+        - find scripts -type f -name "*.py" | xargs pylint --rcfile=.pylintrc
         # check the examples
-        - pylint --rcfile=.pylintrc-wip examples/**.py
+        - find examples -type f -name "*.py" | xargs pylint --rcfile=.pylintrc-wip
         # -------------
         # mypy checking:
         - mypy

CHANGELOG.txt

@@ -1,3 +1,61 @@
+Version 4.0.0
+====
+
+(In development)
+
+
+Version 3.3.4
+====
+
+Last call for Python2 support.
+
+* #850 Fix socket.error is a deprecated alias of OSError used on Python versions lower than 3.3.
+
+Version 3.3.3
+====
+
+Backported fixes from 4.x development branch which targets Python 3.
+
+* #798 Backport caching msg.data value in neovi interface.
+* #796 Fix Vector CANlib treatment of empty app name.
+* #771 Handle empty CSV file.
+* #741 ASCII reader can now handle FD frames.
+* #740 Exclude test packages from distribution.
+* #713 RTR crash fix in canutils log reader parsing RTR frames.
+* #701 Skip J1939 messages in ASC Reader.
+* #690 Exposes a configuration option to allow the CAN message player to send error frames
+  (and sets the default to not send error frames).
+* #638 Fixes the semantics provided by periodic tasks in SocketCAN interface.
+* #628 Avoid padding CAN_FD_MESSAGE_64 objects to 4 bytes.
+* #617 Fixes the broken CANalyst-II interface.
+* #605 Socketcan BCM status fix.
+
+
+Version 3.3.2
+====
+
+Minor bug fix release addressing issue in PCAN RTR.
+
+Version 3.3.1
+====
+
+Minor fix to setup.py to only require pytest-runner when necessary.
+
+Version 3.3.0
+====
+
+* Adding CAN FD 64 frame support to blf reader
+* Updates to installation instructions
+* Clean up bits generator in PCAN interface #588
+* Minor fix to use latest tools when building wheels on travis.
+
+Version 3.2.1
+====
+
+* CAN FD 64 frame support to blf reader
+* Minor fix to use latest tools when building wheels on travis.
+* Updates links in documentation.
+
 Version 3.2.0
 ====
 

can/__init__.py

@@ -1,12 +1,15 @@
 """
-``can`` is an object-orient Controller Area Network (CAN) interface module.
+The ``can`` package provides controller area network support for
+Python developers; providing common abstractions to
+different hardware devices, and a suite of utilities for sending and receiving
+messages on a can bus.
 """
 
 import logging
 
 from typing import Dict, Any
 
-__version__ = "3.2.0"
+__version__ = "4.0.0-dev"
 
 log = logging.getLogger("can")
 

can/interfaces/ixxat/canlib.py

@@ -531,7 +531,7 @@ def __init__(self, channel, can_filters=None, **kwargs):
                     constants.CAN_ACC_MASK_NONE,
                 )
             for can_filter in can_filters:
-                # Whitelist
+                # Filters define what messages are accepted
                 code = int(can_filter["can_id"])
                 mask = int(can_filter["can_mask"])
                 extended = can_filter.get("extended", False)

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
 
@@ -32,7 +32,7 @@
 # Import Modules
 # ==============
 from can import BusABC, Message
-from can.util import len2dlc, dlc2len
+from can.util import len2dlc, dlc2len, deprecated_args_alias
 from .exceptions import VectorError
 
 # Define Module Logger
@@ -54,6 +54,16 @@
 class VectorBus(BusABC):
     """The CAN Bus implemented for the Vector interface."""
 
+    deprecated_args = dict(
+        sjwAbr="sjw_abr",
+        tseg1Abr="tseg1_abr",
+        tseg2Abr="tseg2_abr",
+        sjwDbr="sjw_dbr",
+        tseg1Dbr="tseg1_dbr",
+        tseg2Dbr="tseg2_dbr",
+    )
+
+    @deprecated_args_alias(**deprecated_args)
     def __init__(
         self,
         channel,
@@ -66,12 +76,12 @@ def __init__(
         serial=None,
         fd=False,
         data_bitrate=None,
-        sjwAbr=2,
-        tseg1Abr=6,
-        tseg2Abr=3,
-        sjwDbr=2,
-        tseg1Dbr=6,
-        tseg2Dbr=3,
+        sjw_abr=2,
+        tseg1_abr=6,
+        tseg2_abr=3,
+        sjw_dbr=2,
+        tseg1_dbr=6,
+        tseg2_dbr=3,
         **kwargs,
     ):
         """
@@ -98,6 +108,18 @@ def __init__(
         :param int data_bitrate:
             Which bitrate to use for data phase in CAN FD.
             Defaults to arbitration bitrate.
+        :param int sjw_abr:
+            Bus timing value sample jump width (arbitration).
+        :param int tseg1_abr:
+            Bus timing value tseg1 (arbitration)
+        :param int tseg2_abr:
+            Bus timing value tseg2 (arbitration)
+        :param int sjw_dbr:
+            Bus timing value sample jump width (data)
+        :param int tseg1_dbr:
+            Bus timing value tseg1 (data)
+        :param int tseg2_dbr:
+            Bus timing value tseg2 (data)
         """
         if os.name != "nt" and not kwargs.get("_testing", False):
             raise OSError(
@@ -152,29 +174,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:
@@ -219,19 +231,19 @@ def __init__(
             if fd:
                 self.canFdConf = xlclass.XLcanFdConf()
                 if bitrate:
-                    self.canFdConf.arbitrationBitRate = ctypes.c_uint(bitrate)
+                    self.canFdConf.arbitrationBitRate = int(bitrate)
                 else:
-                    self.canFdConf.arbitrationBitRate = ctypes.c_uint(500000)
-                self.canFdConf.sjwAbr = ctypes.c_uint(sjwAbr)
-                self.canFdConf.tseg1Abr = ctypes.c_uint(tseg1Abr)
-                self.canFdConf.tseg2Abr = ctypes.c_uint(tseg2Abr)
+                    self.canFdConf.arbitrationBitRate = 500000
+                self.canFdConf.sjwAbr = int(sjw_abr)
+                self.canFdConf.tseg1Abr = int(tseg1_abr)
+                self.canFdConf.tseg2Abr = int(tseg2_abr)
                 if data_bitrate:
-                    self.canFdConf.dataBitRate = ctypes.c_uint(data_bitrate)
+                    self.canFdConf.dataBitRate = int(data_bitrate)
                 else:
                     self.canFdConf.dataBitRate = self.canFdConf.arbitrationBitRate
-                self.canFdConf.sjwDbr = ctypes.c_uint(sjwDbr)
-                self.canFdConf.tseg1Dbr = ctypes.c_uint(tseg1Dbr)
-                self.canFdConf.tseg2Dbr = ctypes.c_uint(tseg2Dbr)
+                self.canFdConf.sjwDbr = int(sjw_dbr)
+                self.canFdConf.tseg1Dbr = int(tseg1_dbr)
+                self.canFdConf.tseg2Dbr = int(tseg2_dbr)
 
                 xldriver.xlCanFdSetConfiguration(
                     self.port_handle, self.mask, self.canFdConf
@@ -634,15 +646,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):