File: can_player.1

package info (click to toggle)
python-can 4.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,372 kB
  • sloc: python: 25,840; makefile: 38; sh: 20
file content (71 lines) | stat: -rw-r--r-- 2,606 bytes parent folder | download
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
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CAN_PLAYER "1" "December 2023" "can_player 4.3.1" "User Commands"
.SH NAME
can_player \- CAN data player
.SH DESCRIPTION
usage: player.py [\-h] [\-c CHANNEL]
.IP
[\-i {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}]
[\-b BITRATE] [\-\-fd] [\-\-data_bitrate DATA_BITRATE]
[\-f LOG_FILE] [\-v] [\-\-ignore\-timestamps] [\-\-error\-frames]
[\-g GAP] [\-s SKIP]
\&... input\-file
.PP
Replay CAN traffic.
.SS "positional arguments:"
.TP
extra_args
The remaining arguments will be used for the interface
and logger/player initialisation. For example, `\-i
vector \fB\-c\fR 1 \fB\-\-app\-name\fR=\fI\,MyCanApp\/\fR` is the equivalent to
opening the bus with `Bus('vector', channel=1,
app_name='MyCanApp')
.TP
input\-file
The file to replay. For supported types see
can.LogReader.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-c\fR CHANNEL, \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 {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}, \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 BITRATE, \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\-f\fR LOG_FILE, \fB\-\-file_name\fR LOG_FILE
Path and base log filename, for supported types see
can.LogReader.
.TP
\fB\-v\fR
Also print can frames to stdout. You can add several
of these to enable debugging
.TP
\fB\-\-ignore\-timestamps\fR
Ignore timestamps (send all frames immediately with
minimum gap between frames)
.TP
\fB\-\-error\-frames\fR
Also send error frames to the interface.
.TP
\fB\-g\fR GAP, \fB\-\-gap\fR GAP
<s> minimum time between replayed frames
.TP
\fB\-s\fR SKIP, \fB\-\-skip\fR SKIP
<s> skip gaps greater than 's' seconds