Skip to content

CHANGELOG.md

Latest commit

 

History

History
852 lines (660 loc) · 40.9 KB

CHANGELOG.md

File metadata and controls

852 lines (660 loc) · 40.9 KB

Changelog

Version v4.6.1 - 2025-08-12

Fixed

  • Fix initialisation of an slcan bus, when setting a bitrate. When using CAN 2.0 (not FD), the default setting for data_bitrate was invalid, causing an exception. (#1978)

Version v4.6.0 - 2025-08-05

Removed

  • Remove support for Python 3.8. (#1931)
  • Unknown command line arguments ("extra args") are no longer passed down to can.Bus() instantiation. Use the --bus-kwargs argument instead. (#1949)
  • Remove can.io.generic.BaseIOHandler class. Improve can.io.* type annotations by using typing.Generic. (#1951)

Added

  • Support 11-bit identifiers in the serial interface. (#1758)
  • Keep track of active Notifiers and make Notifier usable as a context manager. Add function Notifier.find_instances(bus) to find the active Notifier for a given bus instance. (#1890)
  • Add Windows support to udp_multicast interface. (#1914)
  • Add FD support to slcan according to CANable 2.0 implementation. (#1920)
  • Add support for error messages to the socketcand interface. (#1941)
  • Add support for remote and error frames in the serial interface. (#1948)
  • Add public functions can.cli.add_bus_arguments and can.cli.create_bus_from_namespace for creating bus command line options. Currently downstream packages need to implement their own logic to configure python-can buses. Now python-can can create and parse bus options for third party packages. (#1949)
  • Add support for remote frames to TRCReader. (#1953)
  • Mention the python-can-candle package in the plugin interface section of the documentation. (#1954)
  • Add new CLI tool python -m can.bridge (or just can_bridge) to create a software bridge between two physical buses. (#1961)

Changed

  • Allow sending Classic CAN frames with a DLC value larger than 8 using the socketcan interface. (#1851)
  • The gs_usb extra dependency was renamed to gs-usb. The lint extra dependency was removed and replaced with new PEP 735 dependency groups lint, docs and test. (#1945)
  • Update dependency name from zlgcan-driver-py to zlgcan. (#1946)
  • Use ThreadPoolExecutor in detect_available_configs() to reduce runtime and add timeout parameter. (#1947)
  • Update contribution guide. (#1960)

Fixed

  • Fix a bug in slcanBus.get_version() and slcanBus.get_serial_number(): If any other data was received during the function call, then None was returned. (#1904)
  • Fix incorrect padding of CAN FD payload in BlfReader. (#1906)
  • Set correct message direction for messages received with kvaser interface and receive_own_messages=True. (#1908)
  • Fix timestamp rounding error in BlfWriter. (#1921)
  • Fix timestamp rounding error in BlfReader. (#1927)
  • Handle timer overflow message and build timestamp according to the epoch in the ixxat interface. (#1934)
  • Avoid unsupported ioctl function call to allow usage of the udp_multicast interface on MacOS. (#1940)
  • Fix configuration file parsing for the state bus parameter. (#1957)
  • Mf4Reader: support non-standard CAN_DataFrame.Dir values in mf4 files created by ihedvall/mdflib. (#1967)
  • PcanBus: Set Message.channel attribute in PcanBus.recv(). (#1969)

Version 4.5.0

Features

  • gs_usb command-line support (and documentation updates and stability fixes) by @BenGardiner in hardbyte#1790
  • Faster and more general MF4 support by @cssedev in hardbyte#1892
  • ASCWriter speed improvement by @pierreluctg in hardbyte#1856
  • Faster Message string representation by @pierreluctg in hardbyte#1858
  • Added Netronic's CANdo and CANdoISO adapters interface by @belliriccardo in hardbyte#1887
  • Add autostart option to BusABC.send_periodic() to fix issue #1848 by @SWolfSchunk in hardbyte#1853
  • Improve TestBusConfig by @zariiii9003 in hardbyte#1804
  • Improve speed of TRCReader by @lebuni in hardbyte#1893

Bug Fixes

  • Fix Kvaser timestamp by @zariiii9003 in hardbyte#1878
  • Set end_time in ThreadBasedCyclicSendTask.start() by @zariiii9003 in hardbyte#1871
  • Fix regex in _parse_additional_config() by @zariiii9003 in hardbyte#1868
  • Fix for #1849 (PCAN fails when PCAN_ERROR_ILLDATA is read via ReadFD) by @bures in hardbyte#1850
  • Period must be >= 1ms for BCM using Win32 API by @pierreluctg in hardbyte#1847
  • Fix ASCReader Crash on "Start of Measurement" Line by @RitheeshBaradwaj in hardbyte#1811
  • Resolve AttributeError within NicanError by @vijaysubbiah20 in hardbyte#1806

Miscellaneous

Version 4.4.2

Bug Fixes

  • Remove abstractmethod decorator from Listener.stop() (#1770, #1795)
  • Fix SizedRotatingLogger file suffix bug (#1792, #1793)
  • gs_usb: Use BitTiming class internally to configure bitrate (#1747, #1748)
  • pcan: Fix unpack error in PcanBus._detect_available_configs() (#1767)
  • socketcan: Improve error handling in SocketcanBus.__init__() (#1771)
  • socketcan: Do not log exception on non-linux platforms (#1800)
  • vector, kvaser: Activate channels after CAN filters were applied (#1413, #1708, #1796)

Features

  • kvaser: Add support for non-ISO CAN FD (#1752)
  • neovi: Return timestamps relative to epoch (#1789)
  • slcan: Support CANdapter extended length arbitration ID (#1506, #1528)
  • slcan: Add support for listen_only mode (#1496)
  • vector: Add support for listen_only mode (#1764)

Version 4.4.0

Features

  • TRC 1.3 Support: Added support for .trc log files as generated by PCAN Explorer v5 and other tools, expanding compatibility with common log file formats (#1753).
  • ASCReader refactor: improved the ASCReader code (#1717).
  • SYSTEC Interface Enhancements: Added the ability to pass an explicit DLC value to the send() method when using the SYSTEC interface, enhancing flexibility for message definitions (#1756).
  • Socketcand Beacon Detection: Introduced a feature for detecting socketcand beacons, facilitating easier connection and configuration with socketcand servers (#1687).
  • PCAN Driver Echo Frames: Enabled echo frames in the PCAN driver when receive_own_messages is set, improving feedback for message transmissions (#1723).
  • CAN FD Bus Connection for VectorBus: Enabled connecting to CAN FD buses without specifying bus timings, simplifying the connection process for users (#1716).
  • Neousys Configs Detection: Updated the detection mechanism for available Neousys configurations, ensuring more accurate and comprehensive configuration discovery (#1744).

Bug Fixes

  • Send Periodic Messages: Fixed an issue where fixed-duration periodic messages were sent one extra time beyond their intended count (#1713).
  • Vector Interface on Windows 11: Addressed compatibility issues with the Vector interface on Windows 11, ensuring stable operation across the latest OS version (#1731).
  • ASCWriter Millisecond Handling: Corrected the handling of milliseconds in ASCWriter, ensuring accurate time representation in log files (#1734).
  • Various minor bug fixes: Addressed several minor bugs to improve overall stability and performance.

Miscellaneous

  • Invert default value logic for BusABC._is_shutdown. (#1774)
  • Implemented various logging enhancements to provide more detailed and useful operational insights (#1703).
  • Updated CI to use OIDC for connecting GitHub Actions to PyPi, improving security and access control for CI workflows.
  • Fix CI to work for MacOS (#1772).

The release also includes various other minor enhancements and bug fixes aimed at improving the reliability and performance of the software.

Version 4.3.1

Bug Fixes

  • Fix socketcand erroneously discarding frames (#1700)
  • Fix initialization order in EtasBus (#1693, #1704)

Documentation

  • Fix install instructions for neovi (#1694, #1697)

Version 4.3.0

Breaking Changes

  • Raise Minimum Python Version to 3.8 (#1597)
  • Do not stop notifier if exception was handled (#1645)

Bug Fixes

  • Vector: channel detection fails, if there is an active flexray channel (#1634)
  • ixxat: Fix exception in 'state' property on bus coupling errors (#1647)
  • NeoVi: Fixed serial number range (#1650)
  • PCAN: Fix timestamp offset due to timezone (#1651)
  • Catch pywintypes.error in broadcast manager (#1659)
  • Fix BLFReader error for incomplete or truncated stream (#1662)
  • PCAN: remove Windows registry check to fix 32bit compatibility (#1672)
  • Vector: Skip the can_op_mode check if the device reports can_op_mode=0 (#1678)
  • Vector: using the config from detect_available_configs might raise XL_ERR_INVALID_CHANNEL_MASK error (#1681)

Features

API

  • Add modifier_callback parameter to BusABC.send_periodic for auto-modifying cyclic tasks (#703)
  • Add protocol property to BusABC to determine active CAN Protocol (#1532)
  • Change Bus constructor implementation and typing (#1557)
  • Add optional strict parameter to relax BitTiming & BitTimingFd Validation (#1618)
  • Add BitTiming.iterate_from_sample_point static methods (#1671)

IO

  • Can Player compatibility with interfaces that use additional configuration (#1610)

Interface Improvements

  • Kvaser: Add BitTiming/BitTimingFd support to KvaserBus (#1510)
  • Ixxat: Implement detect_available_configs for the Ixxat bus. (#1607)
  • NeoVi: Enable send and receive on network ID above 255 (#1627)
  • Vector: Send HighPriority Message to flush Tx buffer (#1636)
  • PCAN: Optimize send performance (#1640)
  • PCAN: Support version string of older PCAN basic API (#1644)
  • Kvaser: add parameter exclusive and override_exclusive (#1660)
  • socketcand: Add parameter tcp_tune to reduce latency (#1683)

Miscellaneous

  • Distinguish Text/Binary-IO for Reader/Writer classes. (#1585)
  • Convert setup.py to pyproject.toml (#1592)
  • activate ruff pycodestyle checks (#1602)
  • Update linter instructions in development.rst (#1603)
  • remove unnecessary script files (#1604)
  • BigEndian test fixes (#1625)
  • align ID: in can.Message string (#1635)
  • Use same configuration file as Linux on macOS (#1657)
  • We do not need to account for drift when we USE_WINDOWS_EVENTS (#1666, #1679)
  • Update linters, activate more ruff rules (#1669)
  • Add Python 3.12 Support / Test Python 3.12 (#1673)

Version 4.2.2

Bug Fixes

  • Fix socketcan KeyError (#1598, #1599).
  • Fix IXXAT not properly shutdown message (#1606).
  • Fix Mf4Reader and TRCReader incompatibility with extra CLI args (#1610).
  • Fix decoding error in Kvaser constructor for non-ASCII product name (#1613).

Version 4.2.1

Bug Fixes

  • The ASCWriter now logs the correct channel for error frames (#1578, #1583).
  • Fix PCAN library detection (#1579, #1580).
  • On Windows, the first two periodic frames were sent without delay (#1590).

Version 4.2.0

Breaking Changes

  • The can.BitTiming class was replaced with the new can.BitTiming and can.BitTimingFd classes (#1468, #1515). Early adopters of can.BitTiming will need to update their code. Check the documentation for more information. Currently, the following interfaces support the new classes:

    • canalystii (#1468)
    • cantact (#1468)
    • nixnet (#1520)
    • pcan (#1514)
    • vector (#1470, #1516)

    There are open pull requests for kvaser (#1510), slcan (#1512) and usb2can (#1511). Testing and reviewing of these open PRs would be most appreciated.

Features

IO

  • Add support for MF4 files (#1289).
  • Add support for version 2 TRC files and other TRC file enhancements (#1530).

Type Annotations

  • Export symbols to satisfy type checkers (#1547, #1551, #1558, #1568).

Interface Improvements

  • Add __del__ method to can.BusABC to automatically release resources (#1489, #1564).
  • pcan: Update PCAN Basic to 4.6.2.753 (#1481).
  • pcan: Use select instead of polling on Linux (#1410).
  • socketcan: Use ip link JSON output in find_available_interfaces (#1478).
  • socketcan: Enable SocketCAN interface tests in GitHub CI (#1484).
  • slcan: improve receiving performance (#1490).
  • usb2can: Stop using root logger (#1483).
  • usb2can: Faster channel detection on Windows (#1480).
  • vector: Only check sample point instead of tseg & sjw (#1486).
  • vector: add VN5611 hwtype (#1501).

Documentation

  • Add new section about related tools to documentation. Add a list of plugin interface packages (#1457).

Bug Fixes

  • Automatic type conversion for config values (#1498, #1499).
  • pcan: Fix Bus.__new__ for CAN-FD interfaces (#1458, #1460).
  • pcan: Fix Detection of Library on Windows on ARM (#1463).
  • socketcand: extended ID bug fixes (#1504, #1508).
  • vector: improve robustness against unknown HardwareType values (#1500, #1502).

Deprecations

  • The bustype parameter of can.Bus is deprecated and will be removed in version 5.0, use interface instead. (#1462).
  • The context parameter of can.Bus is deprecated and will be removed in version 5.0, use config_context instead. (#1474).
  • The bit_timing parameter of CantactBus is deprecated and will be removed in version 5.0, use timing instead. (#1468).
  • The bit_timing parameter of CANalystIIBus is deprecated and will be removed in version 5.0, use timing instead. (#1468).
  • The brs and log_errors parameters of NiXNETcanBus are deprecated and will be removed in version 5.0. (#1520).

Miscellaneous

  • Use high resolution timer on Windows to improve timing precision for BroadcastManager (#1449).
  • Improve ThreadBasedCyclicSendTask timing (#1539).
  • Make code examples executable on Linux (#1452).
  • Fix CanFilter type annotation (#1456).
  • Fix The entry_points().get deprecation warning and improve type annotation of can.interfaces.BACKENDS (#1465).
  • Add ignore_config parameter to can.Bus (#1474).
  • Add deprecation period to utility function deprecated_args_alias (#1477).
  • Add ruff to the CI system (#1551)

Version 4.1.0

Breaking Changes

  • windows-curses was moved to optional dependencies (#1395). Use pip install python-can[viewer] if you are using the can.viewer script on Windows.
  • The attributes of can.interfaces.vector.VectorChannelConfig were renamed from camelCase to snake_case (#1422).

Features

IO

  • The canutils logger preserves message direction (#1244) and uses common interface names (e.g. can0) instead of just channel numbers (#1271).
  • The can.logger script accepts the -a, --append option to add new data to an existing log file (#1326, #1327, #1361). Currently only the blf-, canutils- and csv-formats are supported.
  • All CLI extra_args are passed to the bus, logger and player initialisation (#1366).
  • Initial support for TRC files (#1217)

Type Annotations

  • python-can now includes the py.typed marker to support type checking according to PEP 561 (#1344).

Interface Improvements

  • The gs_usb interface can be selected by device index instead of USB bus/address. Loopback frames are now correctly marked with the is_rx flag (#1270).
  • The PCAN interface can be selected by its device ID instead of just the channel name (#1346).
  • The PCAN Bus implementation supports auto bus-off reset (#1345).
  • SocketCAN: Make find_available_interfaces() find slcanX interfaces (#1369).
  • Vector: Add xlGetReceiveQueueLevel, xlGenerateSyncPulse and xlFlushReceiveQueue to xldriver (#1387).
  • Vector: Raise a CanInitializationError, if the CAN settings can not be applied according to the arguments of VectorBus.__init__ (#1426).
  • Ixxat bus now implements BusState api and detects errors (#1141)

Bug Fixes

  • Improve robustness of USB2CAN serial number detection (#1129).
  • Fix channel2int conversion (#1268, #1269).
  • Fix BLF timestamp conversion (#1266, #1273).
  • Fix timestamp handling in udp_multicast on macOS (#1275, #1278).
  • Fix failure to initiate the Neousys DLL (#1281).
  • Fix AttributeError in IscanError (#1292, #1293).
  • Add missing vector devices (#1296).
  • Fix error for DLC > 8 in ASCReader (#1299, #1301).
  • Set default mode for FileIOMessageWriter to wt instead of rt (#1303).
  • Fix conversion for port number from config file (#1309).
  • Fix fileno error on Windows (#1312, #1313, #1333).
  • Remove redundant writer.stop() call that throws error (#1316, #1317).
  • Detect and cast types of CLI extra_args (#1280, #1328).
  • Fix ASC/CANoe incompatibility due to timestamp format (#1315, #1362).
  • Fix MessageSync timings (#1372, #1374).
  • Fix file name for compressed files in SizedRotatingLogger (#1382, #1683).
  • Fix memory leak in neoVI bus where message_receipts grows with no limit (#1427).
  • Raise ValueError if gzip is used with incompatible log formats (#1429).
  • Allow restarting of transmission tasks for socketcan (#1440)

Miscellaneous

  • Allow ICSApiError to be pickled and un-pickled (#1341)
  • Sort interface names in CLI API to make documentation reproducible (#1342)
  • Exclude repository-configuration from git-archive (#1343)
  • Improve documentation (#1397, #1401, #1405, #1420, #1421, #1434)
  • Officially support Python 3.11 (#1423)
  • Migrate code coverage reporting from Codecov to Coveralls (#1430)
  • Migrate building docs and publishing releases to PyPi from Travis-CI to GitHub Actions (#1433)

Version 4.0.0

TL;DR: This release includes a ton of improvements from 2.5 years of development! 🎉 Test thoroughly after switching.

For more than two years, there was no major release of python-can. However, development was very much active over most of this time, and many parts were switched out and improved. Over this time, over 530 issues and PRs have been resolved or merged, and discussions took place in even more. Statistics of the final diff: About 200 files changed due to ~22k additions and ~7k deletions from more than thirty contributors.

This changelog diligently lists the major changes but does not promise to be the complete list of changes. Therefore, users are strongly advised to thoroughly test their programs against this new version. Re-reading the documentation for your interfaces might be helpful too as limitations and capabilities might have changed or are more explicit. While we did try to avoid breaking changes, in some cases it was not feasible and in particular, many implementation details have changed.

Major features

  • Type hints for the core library and some interfaces (#652 and many others)
  • Support for Python 3.7-3.10+ only (dropped support for Python 2.* and 3.5-3.6) (#528 and many others)
  • Granular and unified exceptions (#356, #562, #1025; overview in #1046)
  • Support for automatic configuration detection in most interfaces (#303, #640, #641, #811, #1077, #1085)
  • Better alignment of interfaces and IO to common conventions and semantics

New interfaces

  • udp_multicast (#644)
  • robotell (#731)
  • cantact (#853)
  • gs_usb (#905)
  • nixnet (#968, #1154)
  • neousys (#980, #1076)
  • socketcand (#1140)
  • etas (#1144)

Improved interfaces

  • socketcan
    • Support for multiple Cyclic Messages in Tasks (#610)
    • Socketcan crash when attempting to stop CyclicSendTask with same arbitration ID (#605, #638, #720)
    • Relax restriction of arbitration ID uniqueness for CyclicSendTask (#721, #785, #930)
    • Add nanosecond resolution time stamping to socketcan (#938, #1015)
    • Add support for changing the loopback flag (#960)
    • Socketcan timestamps are missing sub-second precision (#1021, #1029)
    • Add parameter to ignore CAN error frames (#1128)
  • socketcan_ctypes
    • Removed and replaced by socketcan after deprecation period
  • socketcan_native
    • Removed and replaced by socketcan after deprecation period
  • vector
    • Add chip state API (#635)
    • Add methods to handle non message events (#708)
    • Implement XLbusParams (#718)
    • Add support for VN8900 xlGetChannelTime function (#732, #733)
    • Add vector hardware config popup (#774)
    • Fix Vector CANlib treatment of empty app name (#796, #814)
    • Make VectorError pickleable (#848)
    • Add methods get_application_config(), set_application_config() and set_timer_rate() to VectorBus (#849)
    • Interface arguments are now lowercase (#858)
    • Fix errors using multiple Vector devices (#898, #971, #977)
    • Add more interface information to channel config (#917)
    • Improve timestamp accuracy on Windows (#934, #936)
    • Fix error with VN8900 (#1184)
    • Add static typing (#1229)
  • PCAN
    • Do not incorrectly reset CANMsg.MSGTYPE on remote frame (#659, #681)
    • Add support for error frames (#711)
    • Added keycheck for windows platform for better error message (#724)
    • Added status_string method to return simple status strings (#725)
    • Fix timestamp timezone offset (#777, #778)
    • Add Cygwin support (#840)
    • Update PCAN basic Python file to February 7, 2020 (#929)
    • Fix compatibility with the latest macOS SDK (#947, #948, #957, #976)
    • Allow numerical channel specifier (#981, #982)
    • macOS: Try to find libPCBUSB.dylib before loading it (#983, #984)
    • Disable command PCAN_ALLOW_ERROR_FRAMES on macOS (#985)
    • Force english error messages (#986, #993, #994)
    • Add set/get device number (#987)
    • Timestamps are silently incorrect on Windows without uptime installed (#1053, #1093)
    • Implement check for minimum version of pcan library (#1065, #1188)
    • Handle case where uptime is imported successfully but returns None (#1102, #1103)
  • slcan
    • Fix bitrate setting (#691)
    • Fix fileno crash on Windows (#924)
  • ics_neovi
    • Filter out Tx error messages (#854)
    • Adding support for send timeout (#855)
    • Raising more precise API error when set bitrate fails (#865)
    • Avoid flooding the logger with many errors when they are the same (#1125)
    • Omit the transmit exception cause for brevity (#1086)
    • Raise ValueError if message data is over max frame length (#1177, #1181)
    • Setting is_error_frame message property (#1189)
  • ixxat
    • Raise exception on busoff in recv() (#856)
    • Add support for 666 kbit/s bitrate (#911)
    • Add function to list hwids of available devices (#926)
    • Add CAN FD support (#1119)
  • seeed
    • Fix fileno crash on Windows (#902)
  • kvaser
    • Improve timestamp accuracy on Windows (#934, #936)
  • usb2can
    • Fix "Error 8" on Windows and provide better error messages (#989)
    • Fix crash on initialization (#1248, #1249)
    • Pass flags instead of flags_t type upon initialization (#1252)
  • serial
    • Fix "TypeError: cannot unpack non-iterable NoneType" and more robust error handling (#1000, #1010)
  • canalystii
    • Fix is_extended_id (#1006)
    • Fix transmitting onto a busy bus (#1114)
    • Replace binary library with python driver (#726, #1127)

Other API changes and improvements

  • CAN FD frame support is pretty complete (#963)
    • ASCWriter (#604) and ASCReader (#741)
    • Canutils reader and writer (#1042)
    • Logger, viewer and player tools can handle CAN FD (#632)
    • Many bugfixes and more testing coverage
  • IO
    • Log rotation (#648, #874, #881, #1147)
    • Transparent (de)compression of gzip files for all formats (#1221)
    • Add plugin support to can.io Reader/Writer (#783)
    • ASCReader/Writer enhancements like increased robustness (#820, #1223, #1256, #1257)
    • Adding absolute timestamps to ASC reader (#761)
    • Support other base number (radix) at ASCReader (#764)
    • Add logconvert script (#1072, #1194)
    • Adding support for gzipped ASC logging file (.asc.gz) (#1138)
    • Improve IO class hierarchy (#1147)
  • An overview over various "virtual" interfaces (#644)
  • Make ThreadBasedCyclicSendTask event based & improve timing accuracy (#656)
  • Ignore error frames in can.player by default, add --error-frames option (#690)
  • Add an error callback to ThreadBasedCyclicSendTask (#743, #781)
  • Add direction to CAN messages (#773, #779, #780, #852, #966)
  • Notifier no longer raises handled exceptions in rx_thread (#775, #789) but does so if no listener handles them (#1039, #1040)
  • Changes to serial device number decoding (#869)
  • Add a default fileno function to the BusABC (#877)
  • Disallow Messages to simultaneously be "FD" and "remote" (#1049)
  • Speed up interface plugin imports by avoiding pkg_resources (#1110)
  • Allowing for extra config arguments in can.logger (#1142, #1170)
  • Add changed byte highlighting to viewer.py (#1159)
  • Change DLC to DL in Message.__str__() (#1212)

Other Bugfixes

  • BLF PDU padding (#459)
  • stop_all_periodic_tasks skipping every other task (#634, #637, #645)
  • Preserve capitalization when reading config files (#702, #1062)
  • ASCReader: Skip J1939Tp messages (#701)
  • Fix crash in Canutils Log Reader when parsing RTR frames (#713)
  • Various problems with the installation of the library
  • ASCWriter: Fix date format to show correct day of month (#754)
  • Fixes that some BLF files can't be read ( #763, #765)
  • Seek for start of object instead of calculating it (#786, #803, #806)
  • Only import winreg when on Windows (#800, #802)
  • Find the correct Reader/Writer independently of the file extension case (#895)
  • RecursionError when unpickling message object (#804, #885, #904)
  • Move "filelock" to neovi dependencies (#943)
  • Bus() with "fd" parameter as type bool always resolved to fd-enabled configuration (#954, #956)
  • Asyncio code hits error due to deprecated loop parameter (#1005, #1013)
  • Catch time before 1970 in ASCReader (#1034)
  • Fix a bug where error handlers were not called correctly (#1116)
  • Improved user interface of viewer script (#1118)
  • Correct app_name argument in logger (#1151)
  • Calling stop_all_periodic_tasks() in BusABC.shutdown() and all interfaces call it on shutdown (#1174)
  • Timing configurations do not allow int (#1175)
  • Some smaller bugfixes are not listed here since the problems were never part of a proper release
  • ASCReader & ASCWriter using DLC as data length (#1245, #1246)

Behind the scenes & Quality assurance

  • We publish both source distributions (sdist) and binary wheels (bdist_wheel) (#1059, #1071)
  • Many interfaces were partly rewritten to modernize the code or to better handle errors
  • Performance improvements
  • Dependencies have changed
  • Derive type information in Sphinx docs directly from type hints (#654)
  • Better documentation in many, many places; This includes the examples, README and python-can developer resources
  • Add issue templates (#1008, #1017, #1018, #1178)
  • Many continuous integration (CI) discussions & improvements (for example: #951, #940, #1032)
  • Testing: Many of the new features directly added tests, and coverage of existing code was improved too (for example: #1031, #581, #585, #586, #942, #1196, #1198)

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

Major features

  • FD support added for Pcan by @bmeisels with input from @markuspi, @christiansandberg & @felixdivo in PR #537
  • This is the last version of python-can which will support Python 2.7 and Python 3.5. Support has been removed for Python 3.4 in this release in PR #532

Other notable changes

  • #533 BusState is now an enum.
  • #535 This release should automatically be published to PyPi by travis.
  • #577 Travis-ci now uses stages.
  • #548 A guide has been added for new io formats.
  • #550 Finish moving from nose to pytest.
  • #558 Fix installation on Windows.
  • #561 Tests for MessageSync added.

General fixes, cleanup and docs changes can be found on the GitHub milestone https://github.com/hardbyte/python-can/milestone/7?closed=1

Pulls: #522, #526, #527, #536, #540, #546, #547, #548, #533, #559, #569, #571, #572, #575

Backend Specific Changes

pcan

  • FD

slcan

  • ability to set custom can speed instead of using predefined speed values. #553

socketcan

  • Bug fix to properly support 32bit systems. #573

usb2can

  • slightly better error handling
  • multiple serial devices can be found
  • support for the _detect_available_configs() API

Pulls #511, #535

vector

  • handle app_name. #525

Version 3.1.1

Major features

Two new interfaces this release:

  • SYSTEC contributed by @idaniel86 in PR #466
  • CANalyst-II contributed by @smeng9 in PR #476

Other notable changes

  • #477 The kvaser interface now supports bus statistics via a custom bus method.
  • #434 neovi now supports receiving own messages
  • #490 Adding option to override the neovi library name
  • #488 Allow simultaneous access to IXXAT cards
  • #447 Improvements to serial interface:
    • to allow receiving partial messages
    • to fix issue with DLC of remote frames
    • addition of unit tests
  • #497 Small API changes to Message and added unit tests
  • #471 Fix CAN FD issue in kvaser interface
  • #462 Fix Notifier issue with asyncio
  • #481 Fix PCAN support on OSX
  • #455 Fix to Message initializer
  • Small bugfixes and improvements

Version 3.1.0

Version 3.1.0 was built with old wheel and/or setuptools packages and was replaced with v3.1.1 after an installation but was discovered.

Version 3.0.0

Major features

  • Adds support for developing asyncio applications with python-can more easily. This can be useful when implementing protocols that handles simultaneous connections to many nodes since you can write synchronous looking code without handling multiple threads and locking mechanisms. #388
  • New can viewer terminal application. (python -m can.viewer) #390
  • More formally adds task management responsibility to the Bus. By default tasks created with bus.send_periodic will have a reference held by the bus - this means in many cases the user doesn't need to keep the task in scope for their periodic messages to continue being sent. If this behavior isn't desired pass store_task=False to the send_periodic method. Stop all tasks by calling the bus's new stop_all_periodic_tasks method. #412

Breaking changes

  • Interfaces should no longer override send_periodic and instead implement _send_periodic_internal to allow the Bus base class to manage tasks. #426
  • writing to closed writers is not supported any more (it was supported only for some)
  • the file in the reader/writer is now always stored in the attribute uniformly called file, and not in something like fp, log_file or output_file. Changed the name of the first parameter of the read/writer constructors from filename to file.

Other notable changes

  • can.Message class updated #413
    • Addition of a Message.equals method.
    • Deprecate id_type in favor of is_extended_id
    • Initializer parameter extended_id deprecated in favor of is_extended_id
    • documentation, testing and example updates
    • Addition of support for various builtins: repr, slots, copy
  • IO module updates to bring consistency to the different CAN message writers and readers. #348
    • context manager support for all readers and writers
    • they share a common super class called BaseIOHandler
    • all file handles can now be closed with the stop() method
    • the table name in SqliteReader/SqliteWriter can be adjusted
    • append mode added in CSVWriter and CanutilsLogWriter
    • file-like and path-like objects can now be passed to the readers and writers (except to the Sqlite handlers)
    • add a __ne__() method to the Message class (this was required by the tests)
    • added a stop() method for BufferedReader
    • SqliteWriter: this now guarantees that all messages are being written, exposes some previously internal metrics and only buffers messages up to a certain limit before writing/committing to the database.
    • the unused header_line attribute from CSVReader has been removed
    • privatized some attributes that are only to be used internally in the classes
    • the method Listener.on_message_received() is now abstract (using @abc.abstractmethod)
  • Start testing against Python 3.7 #380
  • All scripts have been moved into can/scripts. #370, #406
  • Added support for additional sections to the config #338
  • Code coverage reports added. #346, #374
  • Bug fix to thread safe bus. #397

General fixes, cleanup and docs changes: (#347, #348, #367, #368, #370, #371, #373, #420, #417, #419, #432)

Backend Specific Changes

3rd party interfaces

  • Deprecated python_can.interface entry point instead use can.interface. #389

neovi

  • Added support for CAN-FD #408
  • Fix issues checking if bus is open. #381
  • Adding multiple channels support. #415

nican

  • implements reset instead of custom flush_tx_buffer. #364

pcan

  • now supported on OSX. #365

serial

  • Removed TextIOWrapper from serial. #383
  • switch to serial_for_url enabling using remote ports via loop://, ``socket://andrfc2217://` URLs. #393
  • hardware handshake using rtscts kwarg #402

socketcan

  • socketcan tasks now reuse a bcm socket #404, #425, #426,
  • socketcan bugfix to receive error frames #384

vector

  • Vector interface now implements _detect_available_configs. #362
  • Added support to select device by serial number. #387

Version 2.2.1 (2018-07-12)

  • Fix errors and warnings when importing library on Windows
  • Fix Vector backend raising ValueError when hardware is not connected

Version 2.2.0 (2018-06-30)

  • Fallback message filtering implemented in Python for interfaces that don't offer better accelerated mechanism.
  • SocketCAN interfaces have been merged (Now use socketcan instead of either socketcan_native and socketcan_ctypes), this is now completely transparent for the library user.
  • automatic detection of available configs/channels in supported interfaces.
  • Added synchronized (thread-safe) Bus variant.
  • context manager support for the Bus class.
  • Dropped support for Python 3.3 (officially reached end-of-life in Sept. 2017)
  • Deprecated the old CAN module, please use the newer can entry point (will be removed in an upcoming major version)

Version 2.1.0 (2018-02-17)

  • Support for out of tree can interfaces with pluggy.
  • Initial support for CAN-FD for socketcan_native and kvaser interfaces.
  • Neovi interface now uses Intrepid Control Systems's own interface library.
  • Improvements and new documentation for SQL reader/writer.
  • Fix bug in neovi serial number decoding.
  • Add testing on OSX to TravisCI
  • Fix non english decoding error on pcan
  • Other misc improvements and bug fixes

Version 2.0.0 (2018-01-05)

After an extended baking period we have finally tagged version 2.0.0!

Quite a few major changes from v1.x:

  • New interfaces:
    • Vector
    • NI-CAN
    • isCAN
    • neoVI
  • Simplified periodic send API with initial support for SocketCAN
  • Protocols module including J1939 support removed
  • Logger script moved to module can.logger
  • New can.player script to replay log files
  • BLF, ASC log file support added in new can.io module

You can install from PyPi with pip:

pip install python-can==2.0.0

The documentation for v2.0.0 is available at http://python-can.readthedocs.io/en/2.0.0/