1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH CAN_LOGGER "1" "October 2025" "can_logger 4.6.1" "User Commands"
.SH NAME
can_logger \- log CAN traffic, printing messages to stdout or to a given file
.SH DESCRIPTION
usage: can_logger [\-h] [\-f LOG_FILE] [\-a] [\-s FILE_SIZE] [\-v] [\-\-active |
.IP
\fB\-\-passive]\fR [\-c CHANNEL]
[\-i INTERFACE]
[\-b BITRATE] [\-\-fd] [\-\-data\-bitrate DATA_BITRATE]
[\-\-timing TIMING_ARG [TIMING_ARG ...]]
[\-\-filter {<can_id>:<can_mask>,<can_id>~<can_mask>} [{<can_id>:<can_mask>,<can_id>~<can_mask>} ...]]
[\-\-bus\-kwargs BUS_KWARG [BUS_KWARG ...]]
\&...
.PP
Log CAN traffic, printing messages to stdout or to a given file.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS "logger arguments:"
.TP
\fB\-f\fR, \fB\-\-file_name\fR LOG_FILE
Path and base log filename, for supported types see
can.Logger.
.TP
\fB\-a\fR, \fB\-\-append\fR
Append to the log file if it already exists.
.TP
\fB\-s\fR, \fB\-\-file_size\fR FILE_SIZE
Maximum file size in bytes. Rotate log file when size
threshold is reached. (The resulting file sizes will
be consistent, but are not guaranteed to be exactly
what is specified here due to the rollover conditions
being logger implementation specific.)
.TP
\fB\-v\fR
How much information do you want to see at the command
line? You can add several of these e.g., \fB\-vv\fR is DEBUG
.TP
\fB\-\-active\fR
Start the bus as active, this is applied by default.
.TP
\fB\-\-passive\fR
Start the bus as passive.
.TP
extra_args
The remaining arguments will be used for logger/player
initialisation. For example, `can_logger \fB\-i\fR virtual \fB\-c\fR
test \fB\-f\fR logfile.blf \fB\-\-compression\-level\fR=\fI\,9\/\fR` passes the
keyword argument `compression_level=9` to the
BlfWriter.
.SS "bus arguments:"
.TP
\fB\-c\fR, \fB\-\-channel\fR CHANNEL
Most backend interfaces require some sort of channel.
For example with the serial interface the channel
might be a rfcomm device: "/dev/rfcomm0". With the
socketcan interface valid channel examples include:
"can0", "vcan0".
.TP
\fB\-i\fR, \fB\-\-interface\fR {canalystii,cantact,etas,gs_usb,iscan,ixxat,kvaser,neousys,neovi,nican,nixnet,pcan,robotell,seeedstudio,serial,slcan,socketcan,socketcand,systec,udp_multicast,usb2can,vector,virtual}
Specify the backend CAN interface to use. If left
blank, fall back to reading from configuration files.
.TP
\fB\-b\fR, \fB\-\-bitrate\fR BITRATE
Bitrate to use for the CAN bus.
.TP
\fB\-\-fd\fR
Activate CAN\-FD support
.TP
\fB\-\-data\-bitrate\fR DATA_BITRATE
Bitrate to use for the data phase in case of CAN\-FD.
.TP
\fB\-\-timing\fR TIMING_ARG [TIMING_ARG ...]
Configure bit rate and bit timing. For example, use
`\-\-timing f_clock=8_000_000 tseg1=5 tseg2=2 sjw=2
brp=2 nof_samples=1` for classical CAN or `\-\-timing
f_clock=80_000_000 nom_tseg1=119 nom_tseg2=40
nom_sjw=40 nom_brp=1 data_tseg1=29 data_tseg2=10
data_sjw=10 data_brp=1` for CAN FD. Check the pythoncan documentation to verify whether your CAN interface
supports the `timing` argument.
.TP
\fB\-\-filter\fR {<can_id>:<can_mask>,<can_id>~<can_mask>} [{<can_id>:<can_mask>,<can_id>~<can_mask>} ...]
R|Space separated CAN filters for the given CAN
interface: <can_id>:<can_mask> (matches when
<received_can_id> & mask == can_id & mask)
<can_id>~<can_mask> (matches when <received_can_id> &
mask != can_id & mask) Fx to show only frames with ID
0x100 to 0x103 and 0x200 to 0x20F: python3 \fB\-m\fR
can.viewer \fB\-\-filter\fR 100:7FC 200:7F0 Note that the ID
and mask are always interpreted as hex values
.TP
\fB\-\-bus\-kwargs\fR BUS_KWARG [BUS_KWARG ...]
Pass keyword arguments down to the instantiation of
the bus class. For example, `\-i vector \fB\-c\fR 1 \fB\-\-buskwargs\fR app_name=MyCanApp serial=1234` is equivalent to
opening the bus with `can.Bus('vector', channel=1,
app_name='MyCanApp', serial=1234)
|
