Skip to content

Change can.Message #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hardbyte merged 38 commits into from
Sep 28, 2018
Merged

Change can.Message #413

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
7c44101
use is_extended_id instead of id_type for message objects
felixdivo Sep 6, 2018
b3fd52f
better documentation
felixdivo Sep 6, 2018
00903f8
document check option
felixdivo Sep 6, 2018
6204cda
fixes for the Message class
felixdivo Sep 6, 2018
965bbbb
run test on CI for logformats_test.py
felixdivo Sep 6, 2018
1797e43
added channel to docs
felixdivo Sep 6, 2018
e76f017
add example messages with channel attribute set
felixdivo Sep 6, 2018
4e23808
test codecov
felixdivo Sep 8, 2018
f71fd56
change logformat tests
felixdivo Sep 10, 2018
a20f4f7
nicer __repr__
felixdivo Sep 10, 2018
5217880
add __slots__, correct __hash__. deprecate id_type
felixdivo Sep 10, 2018
edb2b6e
make timestamp comparisoun a bit more forgiving
felixdivo Sep 10, 2018
ec9f9ed
use extended_id in constructor
felixdivo Sep 10, 2018
1a76644
fix TestBlfFileFormat test
felixdivo Sep 10, 2018
26b2406
implemented Message._check
felixdivo Sep 10, 2018
52ab605
adjust logformat test
felixdivo Sep 10, 2018
a724a92
Merge branch 'develop' into change-messages
felixdivo Sep 10, 2018
5d88662
try to add warning & compat __dict__
felixdivo Sep 15, 2018
c0fe8a7
Merge branch 'change-messages' of github.com:hardbyte/python-can into…
felixdivo Sep 15, 2018
5fb1775
properly implement warning
felixdivo Sep 16, 2018
eee819f
update deprecation notes
felixdivo Sep 16, 2018
00f6b92
docs & remove undocumented setting of flags in kvaser backend
felixdivo Sep 16, 2018
da6d180
docs
felixdivo Sep 16, 2018
9791761
compare by identity; add _dict to __hash__()
felixdivo Sep 23, 2018
95cc0b5
address PR comments
felixdivo Sep 23, 2018
f4c532e
remove leftover code
felixdivo Sep 23, 2018
360cfdf
Merge branch 'develop' into change-messages
felixdivo Sep 23, 2018
43586e9
resolve bad merge commit
felixdivo Sep 23, 2018
afe9cf6
added missing comma
felixdivo Sep 23, 2018
58a31f3
add __copy__ and __deepcopy__
felixdivo Sep 23, 2018
e840d36
docs
felixdivo Sep 23, 2018
e27fafb
fix bad test case
felixdivo Sep 27, 2018
196cd89
add Message.equals(), and correctly check for equality in failing tests
felixdivo Sep 27, 2018
2499c95
Merge branch 'develop' into change-messages
felixdivo Sep 27, 2018
fddef63
Merge branch 'develop' into change-messages
felixdivo Sep 27, 2018
c28a106
Remove message hash implementation
hardbyte Sep 28, 2018
5eb4fa4
Merge branch 'develop' into change-messages
hardbyte Sep 28, 2018
68d8e45
Fix missing space in setup
hardbyte Sep 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
better documentation
  • Loading branch information
@felixdivo
felixdivo committed Sep 6, 2018
commit b3fd52f014c7e4fde2e8795e570fa7fd57a7cc19
11 changes: 11 additions & 0 deletions doc/listeners.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ the CAN bus.
.. autoclass:: can.Listener
:members:

There are some listeners that already ship toghether with `python-can`
and are listed below.
Some of them allow messages to be written to files, and the corresponing file
readers are also documented here.

.. warning ::

Please note that writing and the reading a message might not always yield a
completely unchanged message agian, since some properties are not (yet)
Copy link
Copy Markdown
Owner

@hardbyte hardbyte Sep 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in together, corresponding and again.

supported by some file formats.


BufferedReader
--------------
Expand Down
5 changes: 3 additions & 2 deletions doc/message.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Message
The frame identifier used for arbitration on the bus.

The arbitration ID can take an int between 0 and the
maximum value allowed depending on the is_extended_id flag
maximum value allowed depending on the ``is_extended_id`` flag
(either 2\ :sup:`11` - 1 for 11-bit IDs, or
2\ :sup:`29` - 1 for 29-bit identifiers).

Expand Down Expand Up @@ -63,7 +63,7 @@ Message

:type: int

The :abbr:`DLC (Data Link Count)` parameter of a CAN message is an integer
The :abbr:`DLC (Data Length Code)` parameter of a CAN message is an integer
between 0 and 8 representing the frame payload length.

In the case of a CAN FD message, this indicates the data length in
Expand Down Expand Up @@ -96,6 +96,7 @@ Message


Previously this was exposed as `id_type`.
Please use `is_extended_id` from now on.


.. attribute:: is_error_frame
Expand Down