Releases: hardbyte/python-can
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.
v4.4.0-rc.2
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.
v4.3.2 Pre-release 4
v4.3.2-rc.4 Update CI.yml workflow
v4.3.2-rc.3
Allow release without tests
4.3.1
4.3.0
In this release, we've raised the minimum Python version to 3.8, added several new features to the API and as always plenty of bug fixes and interface improvements.
Breaking Changes
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 reportscan_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 toBusABC.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)
4.3.0rc0
Breaking Changes
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 reportscan_op_mode=0
(#1678)
Features
API
- Add
modifier_callback
parameter toBusABC.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)
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)
4.2.2
4.2.1
4.2.0
Breaking Changes
-
The
can.BitTiming
class was replaced with the newcan.BitTiming
andcan.BitTimingFd
classes (#1468, #1515).
Early adopters ofcan.BitTiming
will need to update their code. Check the documentation for more information. Currently, the following interfaces support the new classes: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
Interface Improvements
- Add
__del__
method tocan.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 ofcan.Bus
is deprecated and will be
removed in version 5.0, useinterface
instead. (#1462). - The
context
parameter ofcan.Bus
is deprecated and will be
removed in version 5.0, useconfig_context
instead. (#1474). - The
bit_timing
parameter ofCantactBus
is deprecated and will be
removed in version 5.0, usetiming
instead. (#1468). - The
bit_timing
parameter ofCANalystIIBus
is deprecated and will be
removed in version 5.0, usetiming
instead. (#1468). - The
brs
andlog_errors
parameters ofNiXNETcanBus
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 ofcan.interfaces.BACKENDS
(#1465). - Add
ignore_config
parameter tocan.Bus
(#1474). - Add deprecation period to utility function
deprecated_args_alias
(#1477). - Add
ruff
to the CI system (#1551)