Skip to content

Commit 39a3965

Browse files
Update CHANGELOG.md for 4.2.0 (#1552)
* update CHANGELOG.md * Commit suggestion 1 Co-authored-by: Brian Thorne <hardbyte@gmail.com> * Commit suggestion 2 Co-authored-by: Brian Thorne <hardbyte@gmail.com> * Commit suggestion 3 Co-authored-by: Brian Thorne <hardbyte@gmail.com> * add new entry for MF4 support * update CHANGELOG.md --------- Co-authored-by: Brian Thorne <hardbyte@gmail.com>
1 parent d62c97f commit 39a3965

File tree

2 files changed

+82
-2
lines changed

2 files changed

+82
-2
lines changed

CHANGELOG.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,85 @@
1+
Version 4.2.0
2+
=============
3+
4+
Breaking Changes
5+
----------------
6+
* The ``can.BitTiming`` class was replaced with the new
7+
``can.BitTiming`` and `can.BitTimingFd` classes (#1468, #1515).
8+
Early adopters of ``can.BitTiming`` will need to update their code. Check the
9+
[documentation](https://python-can.readthedocs.io/en/develop/bit_timing.html)
10+
for more information. Currently, the following interfaces support the new classes:
11+
* canalystii (#1468)
12+
* cantact (#1468)
13+
* nixnet (#1520)
14+
* pcan (#1514)
15+
* vector (#1470, #1516)
16+
17+
There are open pull requests for kvaser (#1510), slcan (#1512) and usb2can (#1511). Testing
18+
and reviewing of these open PRs would be most appreciated.
19+
20+
Features
21+
--------
22+
23+
### IO
24+
* Add support for MF4 files (#1289).
25+
* Add support for version 2 TRC files and other TRC file enhancements (#1530).
26+
27+
### Type Annotations
28+
* Export symbols to satisfy type checkers (#1547, #1551, #1558).
29+
30+
### Interface Improvements
31+
* Add ``__del__`` method to ``can.BusABC`` to automatically release resources (#1489).
32+
* pcan: Update PCAN Basic to 4.6.2.753 (#1481).
33+
* pcan: Use select instead of polling on Linux (#1410).
34+
* socketcan: Use ip link JSON output in ``find_available_interfaces`` (#1478).
35+
* socketcan: Enable SocketCAN interface tests in GitHub CI (#1484).
36+
* slcan: improve receiving performance (#1490).
37+
* usb2can: Stop using root logger (#1483).
38+
* usb2can: Faster channel detection on Windows (#1480).
39+
* vector: Only check sample point instead of tseg & sjw (#1486).
40+
* vector: add VN5611 hwtype (#1501).
41+
42+
Documentation
43+
-------------
44+
* Add new section about related tools to documentation. Add a list of
45+
plugin interface packages (#1457).
46+
47+
Bug Fixes
48+
---------
49+
* Automatic type conversion for config values (#1498, #1499).
50+
* pcan: Fix ``Bus.__new__`` for CAN-FD interfaces (#1458, #1460).
51+
* pcan: Fix Detection of Library on Windows on ARM (#1463).
52+
* socketcand: extended ID bug fixes (#1504, #1508).
53+
* vector: improve robustness against unknown HardwareType values (#1500, #1502).
54+
55+
Deprecations
56+
------------
57+
* The ``bustype`` parameter of ``can.Bus`` is deprecated and will be
58+
removed in version 5.0, use ``interface`` instead. (#1462).
59+
* The ``context`` parameter of ``can.Bus`` is deprecated and will be
60+
removed in version 5.0, use ``config_context`` instead. (#1474).
61+
* The ``bit_timing`` parameter of ``CantactBus`` is deprecated and will be
62+
removed in version 5.0, use ``timing`` instead. (#1468).
63+
* The ``bit_timing`` parameter of ``CANalystIIBus`` is deprecated and will be
64+
removed in version 5.0, use ``timing`` instead. (#1468).
65+
* The ``brs`` and ``log_errors`` parameters of `` NiXNETcanBus`` are deprecated
66+
* and will be removed in version 5.0. (#1520).
67+
68+
Miscellaneous
69+
-------------
70+
* Use high resolution timer on Windows to improve
71+
timing precision for BroadcastManager (#1449).
72+
* Improve ThreadBasedCyclicSendTask timing (#1539).
73+
* Make code examples executable on Linux (#1452).
74+
* Fix CanFilter type annotation (#1456).
75+
* Fix ``The entry_points().get`` deprecation warning and improve
76+
type annotation of ``can.interfaces.BACKENDS`` (#1465).
77+
* Add ``ignore_config`` parameter to ``can.Bus`` (#1474).
78+
* Add deprecation period to utility function ``deprecated_args_alias`` (#1477).
79+
* Add `ruff` to the CI system (#1551)
80+
181
Version 4.1.0
2-
====
82+
=============
383

484
Breaking Changes
585
----------------

can/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import logging
99
from typing import Any, Dict
1010

11-
__version__ = "4.1.0"
11+
__version__ = "4.2.0rc0"
1212
__all__ = [
1313
"ASCReader",
1414
"ASCWriter",

0 commit comments

Comments
 (0)